v53

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

Preference Topics

Replace Topic in Section

Replace a topic within a workspace preference. Full document replacement; missing optional fields are cleared. Same 404 rules as GET.

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

section_idstring required

Id of the workspace preference.

topic_idstring required

Id of the subscription preference topic.

namestring required

Human-readable name for the preference topic.

descriptionstring nullable

Optional description shown under the topic on the hosted preferences page. Omit to clear.

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

routing_optionsChannelClassification[] nullable

Default channels delivered for this topic. Omit to clear.

allowed_preferencesAllowedPreference[] nullable

Preference controls a recipient may customize. Omit to clear.

include_unsubscribe_headerboolean nullable

Whether to include a list-unsubscribe header on emails for this topic.

topic_dataobject nullable

Arbitrary metadata associated with the topic. Omit to clear.

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.