Skip to main content
PATCH
Update topic

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId
string<uuid>
required

The ID of the model.

Example:

"123e4567-e89b-12d3-a456-426614174000"

topicName
string
required

The name of the topic.

Example:

"sales_analytics"

Query Parameters

branch_id
string<uuid>

Branch ID to use for branch-aware operations

Example:

"123e4567-e89b-12d3-a456-426614174001"

Body

application/json
description
string

Description of the topic, shown in the topic picker

Example:

"Details about the Blobs R Us product roadmap"

groupLabel
string

Group label for the topic

Example:

"Product"

hidden
boolean

Whether the topic is hidden from the topic picker.

Example:

false

label
string

The display label for the topic

Example:

"Blob Roadmap"

newTopicName
string

The new name of the topic, if performing a rename.

Example:

"2026 Blob Roadmap"

Response

Topic updated successfully

success
boolean
Example:

true