Publish Preferences Page
Publishes the workspace preference page, snapshotting every preference and topic, and returns the page id and a preview URL.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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.
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
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 shown at the top of the hosted preferences page.
Description shown under the heading on the hosted preferences page.
Brand for the hosted page - "default" (workspace default brand), "none" (no brand), or a specific brand id. Defaults to "default".
Response
Result of publishing the workspace's preferences page.
Id of the published page snapshot.
ISO-8601 timestamp of the publish.
Monotonic published version (epoch milliseconds).
Id of the publisher.
Draft-mode hosted preferences page URL for previewing.