Journeys

Create a notification template scoped to a journey

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

post/journeys/{templateId}/templates

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

Changed in 4 of the 55 revisions of this API.47

  • cb858603415822See the full diff
    • removed subschema #1 subschema #3 subschema #7 from the notification/content/elements/items/ request property oneOf list

      request-property-one-of-removed

    • added subschema #1 subschema #3 subschema #7 to the content/elements/items/ response property oneOf list for the response status 201

      response-property-one-of-added

    • added subschema #1 subschema #3 subschema #7 to the notification/content/elements/items/ request property oneOf list

      request-property-one-of-added

    • removed subschema #1 subschema #3 subschema #7 from the content/elements/items/ response property oneOf list for the response status 201

      response-property-one-of-removed

    • added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

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

      new-optional-request-parameter

  • d2377425a72922See the full diff
    • removed subschema #4 subschema #5 from the notification/content/elements/items/ request property oneOf list

      request-property-one-of-removed

    • added subschema #4 subschema #5 to the content/elements/items/ response property oneOf list for the response status 201

      response-property-one-of-added

    • added subschema #4 subschema #5 to the notification/content/elements/items/ request property oneOf list

      request-property-one-of-added

    • removed subschema #4 subschema #5 from the content/elements/items/ response property oneOf list for the response status 201

      response-property-one-of-removed

    • endpoint added

      endpoint-added