Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Topics

Update a topic

Update a topic name by its unique key identifier topicKey

patch/v2/topics/{topicKey}

Path parameters

topicKeystring required

The key identifier of the topic

Headers

idempotency-keystring

A header for idempotency purposes

Request body

namestring required

The display name for the topic

Example request

{
  "name": "Updated Topic Name"
}

Response

OK

_idstring required

The identifier of the topic

keystring required

The unique key of the topic

namestring

The name of the topic

createdAtstring

The date the topic was created

updatedAtstring

The date the topic was last updated

Example response

{
  "_id": "64da692e9a94fb2e6449ad06",
  "key": "product-updates",
  "name": "Product Updates",
  "createdAt": "2023-08-15T00:00:00.000Z",
  "updatedAt": "2023-08-15T00:00:00.000Z"
}