v1

latestOpenAPI 3.0.12026-07-24210349345.4 KB

Topics

Create topic

Creates a new preference center topic. For SMART campaigns, set hideFromUi: true so the topic is used for campaign logic but not shown in the customer-facing preference center. Name must be unique within the brand group. brandGroupId must reference an existing brand group.

post/preference-center/api/v1/topics

Request body

namestring required

Display name of the topic (must be unique within brand group)

descriptionstring required

Description of the topic

brandGroupIdstring uuid required

Brand group this topic belongs to (must exist)

hideFromUiboolean nullable

Set to true for SMART campaign topics so they are hidden from the preference center UI

Response

Topic created successfully.

idstring uuid

Unique identifier of the topic (set by server on create)

namestring

Display name of the topic

descriptionstring

Description of the topic

parentIdstring uuid nullable

Parent topic ID for hierarchical topics

orderinteger

Display order in the preference center

brandGroupIdstring uuid

Brand group this topic belongs to

createdAtstring date-time nullable

Set by server

createdBystring nullable

Set by server from auth context

updatedAtstring date-time nullable

Set by server

updatedBystring nullable

Set by server from auth context

hideFromUiboolean nullable

When true, topic is hidden from the preference center UI (e.g. SMART campaign topics). Cannot be changed after creation.