TRtrycourier
Preference Topics

Replace a preference section

Changed on

Replace a workspace preference. Full document replacement; missing optional fields are cleared. Topics attached to the workspace preference are unaffected.

put/preferences/sections/{section_id}

Request

Path parameters

section_idstring required

Id of the workspace preference.

Request body

namestring required

Human-readable name for the workspace preference.

descriptionstring nullable

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

routing_optionsChannelClassification[] nullable

Default channels for the workspace preference. Omit to clear.

has_custom_routingboolean nullable

Whether the workspace preference defines custom routing for its topics.

Response

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

  • f76bed79a913Revision changes
    • info

      api tag Preference Topics added

    • info

      api tag Workspace Preferences removed

  • 49e3cc128b6cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status