Skip to main content
POST
Preview a post on a Site

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

siteId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"site_8f2kq1"

Body

application/json
postId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"post_123"

lifetime
enum<string>
default:1d

How long the preview stays open.

Available options:
1h,
1d,
3d,
7d
password
string

Lets people outside the workspace open the preview with this password.

Required string length: 8 - 128

Response

Preview queued

preview
object | null
required

Null when the post has no preview on this Site.

organization
object
required