TRtrycourier
Journeys

Create a notification template scoped to a journey

Changed on

Create a notification template scoped to this journey. Defaults to DRAFT state; pass state: "PUBLISHED" to publish on create.

post/journeys/{templateId}/templates

Request

Path parameters

templateIdstring required

Journey id

Headers

Idempotency-Keystring

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expirationstring

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Request body

statestring
channelstring required
providerKeystring

Example request

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

Response

Created notification template

namestring required
tagsstring[] required
idstring required
state'DRAFT' | 'PUBLISHED' required
createdinteger required
creatorstring required
updatedinteger
updaterstring

Example response

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

Changes

  • cb8586034158Revision changes
    • breaking

      removed subschema #1 subschema #3 subschema #7 from the /// request property oneOf list

    • breaking

      added subschema #1 subschema #3 subschema #7 to the // response property oneOf list for the response status

    • info

      added subschema #1 subschema #3 subschema #7 to the /// request property oneOf list

    • info

      removed subschema #1 subschema #3 subschema #7 from the // response property oneOf list for the response status

  • f76bed79a913Revision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional header request parameter x-idempotency-expiration