v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB

Preference Topics

Publish Preferences Page

Publishes the workspace preference page, snapshotting every preference and topic, and returns the page id and a preview URL.

post/preferences/publish

Headers

Idempotency-Keystring

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-expirationstring

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.

Request body

headingstring nullable

Heading shown at the top of the hosted preferences page.

descriptionstring nullable

Description shown under the heading on the hosted preferences page.

brand_idstring nullable

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

Response

page_idstring required

Id of the published page snapshot.

published_atstring required

ISO-8601 timestamp of the publish.

published_bystring nullable

Id of the publisher.

published_versionnumber required

Monotonic published version (epoch milliseconds).

preview_urlstring nullable

Draft-mode hosted preferences page URL for previewing.