Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

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

Headers

idempotency-key
string

A header for idempotency purposes

Path Parameters

topicKey
string
required

The key identifier of the topic

Body

application/json
name
string

The display name for the topic

Maximum string length: 100
Example:

"Updated Topic Name"

data
object | null

Additional custom data associated with the topic. Flat key-value pairs of scalars (string, number, boolean, string[]). Maximum size: 64KB. Pass null to clear.

Example:

Response

OK

_id
string
required

The identifier of the topic

Example:

"64da692e9a94fb2e6449ad06"

key
string
required

The unique key of the topic

Example:

"product-updates"

name
string

The name of the topic

Example:

"Product Updates"

data
object

Additional custom data associated with the topic

Example:
createdAt
string

The date the topic was created

Example:

"2023-08-15T00:00:00.000Z"

updatedAt
string

The date the topic was last updated

Example:

"2023-08-15T00:00:00.000Z"