Sign in
Workspace Preferences

Create Workspace Preference

Create a workspace preference. The workspace preference id is generated and returned. Topics are created inside a workspace preference via POST /preferences/sections/{section_id}/topics.

post/preferences/sections

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