Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Accepts either a raw API key or Bearer <key>.

Headers

​
revision
string

Optional dated API revision for the request. Must use YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-01"

Body

application/json

Create a preference center topic. Topics cannot be deleted at this time.

​
name
string
required

Topic name. Unique per project, ignoring case. Trimmed before save.

Required string length: 1 - 255
​
description
string

Optional description, at most 200 characters.

Maximum string length: 200
​
default_status
enum<string>
default:subscribed

Default subscription status for profiles with no explicit choice. Defaults to subscribed.

Available options:
subscribed,
unsubscribed

Response

Topic created.

A preference center subscription category. Topics cannot be deleted at this time.

​
id
integer
required
​
name
string
required

Topic name. Must be unique per project, ignoring case. Trimmed before save.

​
default_status
enum<string>
required

Default subscription status for profiles with no explicit choice.

Available options:
subscribed,
unsubscribed
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string

Optional description. Omitted from the response when blank.

Maximum string length: 200