Sign in

v4

OpenAPI 3.0.0MIT2026-07-311554531.6 MB
Topics

Create a topic

Creates a new topic if it does not exist, or updates an existing topic if it already exists. Use ?failIfExists=true to prevent updates.

post/v2/topics

Query parameters

failIfExistsboolean

If true, the request will fail if a topic with the same key already exists

Request body

keystring required

The unique key identifier for the topic. The key must contain only alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), underscores (_), colons (:), or be a valid email address.

namestring

The display name for the topic

Example request

{
  "key": "task:12345",
  "name": "Task Title"
}

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"
}