Create a preference section
Creates a workspace preference and returns its generated id. Add subscription topics to it afterwards with the topics endpoint.
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
Request body for creating a workspace preference.
Human-readable name for the workspace preference.
Optional description shown under the section on the hosted preferences page.
Default channels for the workspace preference. Defaults to empty if omitted.
direct_message, email, push, sms, webhook, inbox Whether the workspace preference defines custom routing for its topics.
Response
Created
A workspace preference in your workspace, including its topics.
The workspace preference id.
Human-readable name.
Default channels for the workspace preference. May be empty.
direct_message, email, push, sms, webhook, inbox Whether the workspace preference defines custom routing for its topics.
ISO-8601 timestamp of when the workspace preference was created.
The topics contained in this workspace preference.
Optional description shown under the section on the hosted preferences page.
Id of the creator.
ISO-8601 timestamp of the last update.
Id of the last updater.