Notification Templates

Replace Notification Template

Replace a notification template. All fields are required.

put/notifications/{id}

Path parameters

idstring required

Template ID (nt_ prefix).

Request body

state'DRAFT' | 'PUBLISHED'

Template state after update. Case-insensitive input, normalized to uppercase in the response. Defaults to "DRAFT".

Example request

{
  "notification": {
    "content": {
      "elements": [
        {
          "channel": "email"
        }
      ]
    }
  }
}

Response

namestring required

Display name for the template.

tagsstring[] required

Tags for categorization. Send empty array for none.

idstring required

The template ID.

state'DRAFT' | 'PUBLISHED' required

The template state. Always uppercase.

createdinteger required

Epoch milliseconds when the template was created.

creatorstring required

User ID of the creator.

updatedinteger

Epoch milliseconds of last update.

updaterstring

User ID of the last updater.

Example response

{
  "content": {
    "elements": [
      {
        "channel": "email"
      }
    ]
  }
}

Changes