Templates

Replace Notification Template

Replaces a notification template in full, so send every field rather than only the ones you want changed. Publish separately to make it live.

put/notifications/{id}

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/notifications/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Template ID (nt_ prefix).

state'DRAFT' | 'PUBLISHED'

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

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

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.

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

Aug 10, 2026cb8586034158 Revision changes
- breaking
  added subschema #2: NotificationTemplateAliasWriteFields to the request property allOf list
- breaking
  the request property type changed from object to no type
- breaking
  added subschema #1 subschema #3 subschema #7 to the /// response property oneOf list for the response status
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- info
  added subschema #2: NotificationTemplateResponseFields to the response body allOf list for the response status
- info
  removed subschema #2 from the response body allOf list for the response status
- info
  added the non-success response with the status
- info
  removed subschema #1 subschema #3 subschema #7 from the /// response property oneOf list for the response status
Jul 29, 2026f76bed79a913 Revision changes
- info
  api tag Templates added
- info
  api tag Notification Templates removed