PATCH/topics/{id}

Update a topic

Updates the name, description, or visibility of an existing topic. Supply only the fields you want to change; visibility must be public or private.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
idstringrequired
The ID of the topic to update.

The topic fields to update; include only the values you want to change.

namestringoptional
The name of the topic. Max 50 characters.
descriptionstringoptional
A description of the topic. Max 200 characters.
visibilitystringoptional
The visibility of the topic.
Allowed:publicprivate

1 status code
200Returns the updated topic's ID and object type.
idstringoptional
The ID of the topic.
objectstringoptional
The object type.

Error handling

The id path parameter must identify the topic to update. name must not exceed 50 characters, description must not exceed 200 characters, and visibility must be public or private.