Topics

Update a topic

Update a topic name or data by its unique key identifier topicKey

patch/v2/topics/{topicKey}

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v2/topics/{topicKey}
  • Auth: API key in header Authorization

Path parameters

topicKeystring required

The key identifier of the topic

Request body

namestring

The display name for the topic

dataobject nullable

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 request

{
  "name": "Updated Topic Name",
  "data": {
    "category": "product",
    "priority": 1
  }
}

Response

OK

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.