Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

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-expiration
string

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.

Path Parameters

templateId
string
required

Journey id

Minimum string length: 1

Body

application/json

Request body for creating a notification template scoped to a journey.

channel
string
required
Minimum string length: 1
notification
object
required
state
string
providerKey
string
Minimum string length: 1

Response

Created notification template

A journey-scoped notification template.

name
string
required
tags
string[]
required
brand
object | null
required
subscription
object | null
required
content
object
required
id
string
required
state
enum<string>
default:DRAFT
required
Available options:
DRAFT,
PUBLISHED
created
integer<int64>
required
creator
string
required
updated
integer<int64>
updater
string