Sign in
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}

Path parameters

section_idstring required

Id of the workspace preference.

topic_idstring required

Id of the subscription preference topic.

Request body

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.

Response

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.

Changes

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

  • f76bed79a9132See the full diff
    • ○

      api tag Preference Topics added

      api-tag-added

    • ○

      api tag Workspace Preferences removed

      api-tag-removed

  • 49e3cc128b6c2See the full diff
    • ○

      added the new optional request property description

      new-optional-request-property

    • ○

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

      response-optional-property-added

  • 61131080b1853See the full diff
    • ○

      api operation id preferenceSections_topics_replace removed and replaced with workspacePreferences_topics_replace

      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