v53

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

Preference Topics

Get Topic in Section

Returns one subscription topic with its default status, routing options, allowed preferences, and unsubscribe header setting.

get/preferences/sections/{section_id}/topics/{topic_id}

section_idstring required

Id of the workspace preference.

topic_idstring required

Id of the subscription preference topic.

idstring required

The preference topic id.

namestring required

Human-readable name.

descriptionstring nullable

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

default_status'OPTED_OUT' | 'OPTED_IN' | 'REQUIRED' required

routing_optionsChannelClassification[] required

Default channels delivered for this topic. May be empty.

allowed_preferencesAllowedPreference[] required

Preference controls a recipient may customize. May be empty.

include_unsubscribe_headerboolean required

Whether a list-unsubscribe header is included on emails for this topic.

topic_dataobject required

Arbitrary metadata associated with the topic.

createdstring required

ISO-8601 timestamp of when the topic was created.

creatorstring nullable

Id of the creator.

updatedstring required

ISO-8601 timestamp of the last update.

updaterstring nullable

Id of the last updater.