Skip to main content
PATCH
Update a topic
Partially update a topic. The default_subscription field is immutable. Requires the audience:write scope and is blocked for sandbox API keys.

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

topicId
string<uuid>
required

Topic ID

Body

application/json

Update a topic. All fields are optional. The default_subscription field is immutable.

name
string
Maximum string length: 255
description
string | null
Maximum string length: 1000
visibility
enum<string>

Whether the topic is visible to public subscription pages

Available options:
private,
public
Example:

"public"

Response

Updated

message
string
required
Example:

"Topic retrieved successfully."

data
object
required