Skip to main content
PATCH

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"

Path Parameters

​
id
integer
required

Topic ID.

Body

application/json

Update a topic's name, description and/or default_status. Omitted fields are left unchanged. Pass description as null to clear it. At least one field is required. Topics cannot be deleted at this time.

​
name
string

New name. Must be unique per project. Is case-insensitive.

Required string length: 1 - 255
​
description
string | null

New description, at most 200 characters. Pass null to clear it.

Maximum string length: 200
​
default_status
enum<string>

Default subscription status for profiles with no explicit choice.

Available options:
subscribed,
unsubscribed

Response

Topic updated.

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