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.

Authorization

secretKey

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <secret_key>".

In: header

Query Parameters

failIfExists?boolean

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

key*string

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.

Length1 <= length <= 100

name?string

The display name for the topic

Length0 <= length <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v2/topics" \  -H "Content-Type: application/json" \  -d '{    "key": "task:12345"  }'

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

Authorization

Query Parameters

Request Body

Response Body

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

413application/json

414application/json

415application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`