Sign in
Preference Topics

Create a preference section

Creates a workspace preference and returns its generated id. Add subscription topics to it afterwards with the topics endpoint.

post/preferences/sections

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

namestring required

Human-readable name for the workspace preference.

descriptionstring nullable

Optional description shown under the section on the hosted preferences page.

routing_optionsChannelClassification[] nullable

Default channels for the workspace preference. Defaults to empty if omitted.

has_custom_routingboolean nullable

Whether the workspace preference defines custom routing for its topics.

Response

Created

idstring required

The workspace preference id.

namestring required

Human-readable name.

descriptionstring nullable

Optional description shown under the section on the hosted preferences page.

routing_optionsChannelClassification[] required

Default channels for the workspace preference. May be empty.

has_custom_routingboolean required

Whether the workspace preference defines custom routing for its topics.

createdstring required

ISO-8601 timestamp of when the workspace preference was created.

creatorstring nullable

Id of the creator.

updatedstring nullable

ISO-8601 timestamp of the last update.

updaterstring nullable

Id of the last updater.

Changes

Changed in 4 of the 55 revisions of this API.11

  • f76bed79a9134See the full diff
    • ○

      api tag Preference Topics added

      api-tag-added

    • ○

      api tag Workspace Preferences removed

      api-tag-removed

    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added the new optional header request parameter x-idempotency-expiration

      new-optional-request-parameter

  • 49e3cc128b6c3See the full diff
    • ○

      added the new optional request property description

      new-optional-request-property

    • ○

      added the optional property description to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property topics/items/description to the response with the 201 status

      response-optional-property-added

  • 61131080b1853See the full diff
    • ○

      api operation id preferenceSections_create removed and replaced with workspacePreferences_create

      api-operation-id-removed

    • ○

      api tag Workspace Preferences added

      api-tag-added

    • ○

      api tag Preference Sections removed

      api-tag-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 124a60dd716b1See the full diff
    • ○

      endpoint added

      endpoint-added