Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expiration
string

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Body

application/json

Optional page metadata to apply when publishing the workspace's preferences page. All fields are optional; omitted fields fall back to the page defaults (and the workspace default brand).

heading
string | null

Heading shown at the top of the hosted preferences page.

description
string | null

Description shown under the heading on the hosted preferences page.

brand_id
string | null

Brand for the hosted page - "default" (workspace default brand), "none" (no brand), or a specific brand id. Defaults to "default".

Response

200 - application/json

Result of publishing the workspace's preferences page.

page_id
string
required

Id of the published page snapshot.

published_at
string
required

ISO-8601 timestamp of the publish.

published_version
number
required

Monotonic published version (epoch milliseconds).

published_by
string | null

Id of the publisher.

preview_url
string | null

Draft-mode hosted preferences page URL for previewing.