Skip to main content
POST
Publish a site's Design changes

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
message
string

Commit message. Written from the changes when omitted.

Required string length: 1 - 200
Example:

"Add Jane Doe as an author"

Response

Changes published

published
boolean
required

False when there was nothing to publish.

commitSha
string | null
required

The commit that put the changes live.

deploymentQueued
boolean
required

A production deployment of the commit was queued. False when it could not be queued yet; the site then deploys on its next push.