JavaScript

import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const notificationTemplateResponse = await client.notifications.create({
  notification: {
    name: 'Welcome Email',
    tags: ['onboarding', 'welcome'],
    brand: { id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag' },
    subscription: { topic_id: 'pt_01kx4h2jdafq8bk9a26x0kvd1t' },
    routing: { strategy_id: 'rs_01kx4h2jdafq8bk9amzvy6hbv0' },
    content: { version: '2022-01-01', elements: [{ type: 'channel' }] },
    alias: 'welcome',
  },
  state: 'DRAFT',
});

console.log(notificationTemplateResponse);

import os
from courier import Courier

client = Courier(
    api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
)
notification_template_response = client.notifications.create(
    notification={
        "name": "Welcome Email",
        "tags": ["onboarding", "welcome"],
        "brand": {
            "id": "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"
        },
        "subscription": {
            "topic_id": "pt_01kx4h2jdafq8bk9a26x0kvd1t"
        },
        "routing": {
            "strategy_id": "rs_01kx4h2jdafq8bk9amzvy6hbv0"
        },
        "content": {
            "version": "2022-01-01",
            "elements": [{
                "type": "channel"
            }],
        },
        "alias": "welcome",
    },
    state="DRAFT",
)
print(notification_template_response)

package main

import (
	"context"
	"fmt"

	"github.com/trycourier/courier-go/v4"
	"github.com/trycourier/courier-go/v4/option"
	"github.com/trycourier/courier-go/v4/shared"
)

func main() {
	client := courier.NewClient(
		option.WithAPIKey("My API Key"),
	)
	notificationTemplateResponse, err := client.Notifications.New(context.TODO(), courier.NotificationNewParams{
		NotificationTemplateCreateRequest: courier.NotificationTemplateCreateRequestParam{
			Notification: courier.NotificationTemplateWritePayloadParam{
				NotificationTemplatePayloadParam: courier.NotificationTemplatePayloadParam{
					Brand: courier.NotificationTemplatePayloadBrandParam{
						ID: "bnd_01kx4mrd0pfzw8wt7pn7p2fzag",
					},
					Content: shared.ElementalContentParam{
						Elements: []shared.ElementalNodeUnionParam{{
							OfElementalTextNodeWithType: &shared.ElementalTextNodeWithTypeParam{
								ElementalTextNodeParam: shared.ElementalTextNodeParam{
									ElementalBaseNodeParam: shared.ElementalBaseNodeParam{},
								},
							},
						}},
						Version: "2022-01-01",
					},
					Name: "Welcome Email",
					Routing: courier.NotificationTemplatePayloadRoutingParam{
						StrategyID: "rs_01kx4h2jdafq8bk9amzvy6hbv0",
					},
					Subscription: courier.NotificationTemplatePayloadSubscriptionParam{
						TopicID: "pt_01kx4h2jdafq8bk9a26x0kvd1t",
					},
					Tags: []string{"onboarding", "welcome"},
				},
			},
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", notificationTemplateResponse)
}

package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.ElementalContent;
import com.courier.models.ElementalTextNodeWithType;
import com.courier.models.notifications.NotificationTemplateCreateRequest;
import com.courier.models.notifications.NotificationTemplatePayload;
import com.courier.models.notifications.NotificationTemplateResponse;
import com.courier.models.notifications.NotificationTemplateWritePayload;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        CourierClient client = CourierOkHttpClient.fromEnv();

        NotificationTemplateCreateRequest params = NotificationTemplateCreateRequest.builder()
            .notification(NotificationTemplateWritePayload.builder()
                .brand(NotificationTemplatePayload.Brand.builder()
                    .id("bnd_01kx4mrd0pfzw8wt7pn7p2fzag")
                    .build())
                .content(ElementalContent.builder()
                    .addElement(ElementalTextNodeWithType.builder().build())
                    .version("2022-01-01")
                    .build())
                .name("Welcome Email")
                .routing(NotificationTemplatePayload.Routing.builder()
                    .strategyId("rs_01kx4h2jdafq8bk9amzvy6hbv0")
                    .build())
                .subscription(NotificationTemplatePayload.Subscription.builder()
                    .topicId("pt_01kx4h2jdafq8bk9a26x0kvd1t")
                    .build())
                .addTag("onboarding")
                .addTag("welcome")
                .build())
            .build();
        NotificationTemplateResponse notificationTemplateResponse = client.notifications().create(params);
    }
}

require "courier"

courier = Courier::Client.new(api_key: "My API Key")

notification_template_response = courier.notifications.create(
  notification: {
    brand: {id: "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"},
    content: {elements: [{}], version: "2022-01-01"},
    name: "Welcome Email",
    routing: {strategy_id: "rs_01kx4h2jdafq8bk9amzvy6hbv0"},
    subscription: {topic_id: "pt_01kx4h2jdafq8bk9a26x0kvd1t"},
    tags: ["onboarding", "welcome"]
  }
)

puts(notification_template_response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Courier\Client;
use Courier\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');

try {
  $notificationTemplateResponse = $client->notifications->create(
    notification: [
      'brand' => ['id' => 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag'],
      'content' => [
        'elements' => [['type' => 'channel']], 'version' => '2022-01-01'
      ],
      'name' => 'Welcome Email',
      'routing' => ['strategyID' => 'rs_01kx4h2jdafq8bk9amzvy6hbv0'],
      'subscription' => ['topicID' => 'pt_01kx4h2jdafq8bk9a26x0kvd1t'],
      'tags' => ['onboarding', 'welcome'],
      'alias' => 'welcome',
    ],
    state: 'DRAFT',
    idempotencyKey: 'order-ORD-456-user-123',
    xIdempotencyExpiration: '1785312000',
  );

  var_dump($notificationTemplateResponse);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using TryCourier;
using TryCourier.Models;
using TryCourier.Models.Notifications;

CourierClient client = new();

NotificationCreateParams parameters = new()
{
    Notification = new()
    {
        Brand = new("bnd_01kx4mrd0pfzw8wt7pn7p2fzag"),
        Content = new()
        {
            Elements =
            [
                new ElementalChannelNodeWithType()
                {
                    Type = ElementalChannelNodeWithTypeIntersectionMember1Type.Channel,
                },
            ],
            Version = "2022-01-01",
        },
        Name = "Welcome Email",
        Routing = new("rs_01kx4h2jdafq8bk9amzvy6hbv0"),
        Subscription = new("pt_01kx4h2jdafq8bk9a26x0kvd1t"),
        Tags =
        [
            "onboarding", "welcome"
        ],
        Alias = "welcome",
    },
};

var notificationTemplateResponse = await client.Notifications.Create(parameters);

Console.WriteLine(notificationTemplateResponse);

courier notifications create \
  --api-key 'My API Key' \
  --notification "{brand: {id: bnd_01kx4mrd0pfzw8wt7pn7p2fzag}, content: {elements: [{}], version: '2022-01-01'}, name: Welcome Email, routing: {strategy_id: rs_01kx4h2jdafq8bk9amzvy6hbv0}, subscription: {topic_id: pt_01kx4h2jdafq8bk9a26x0kvd1t}, tags: [onboarding, welcome]}"

curl --request POST \
  --url https://api.courier.com/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notification": {
    "name": "Welcome Email",
    "tags": [
      "onboarding",
      "welcome"
    ],
    "brand": {
      "id": "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"
    },
    "subscription": {
      "topic_id": "pt_01kx4h2jdafq8bk9a26x0kvd1t"
    },
    "routing": {
      "strategy_id": "rs_01kx4h2jdafq8bk9amzvy6hbv0"
    },
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "Welcome!"
            },
            {
              "type": "text",
              "content": "Hello {{data.name}}."
            }
          ]
        }
      ]
    },
    "alias": "welcome"
  },
  "state": "DRAFT"
}
'

{
  "id": "nt_01kx4h2jdafq8bk9aftxak4b40",
  "name": "Welcome Email",
  "tags": [
    "onboarding",
    "welcome"
  ],
  "brand": {
    "id": "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"
  },
  "subscription": {
    "topic_id": "pt_01kx4h2jdafq8bk9a26x0kvd1t"
  },
  "routing": {
    "strategy_id": "rs_01kx4h2jdafq8bk9amzvy6hbv0"
  },
  "content": {
    "version": "2022-01-01",
    "elements": [
      {
        "type": "channel",
        "channel": "email",
        "elements": [
          {
            "type": "meta",
            "title": "Welcome!"
          },
          {
            "type": "text",
            "content": "Hello {{data.name}}."
          }
        ]
      }
    ]
  },
  "alias": "welcome",
  "state": "DRAFT",
  "created": 1710000000000,
  "creator": "user_abc",
  "updated": 1710000000000,
  "updater": "user_abc"
}

Templates

Create Notification Template

Create a notification template. Requires all fields in the notification object. Templates are created in draft state by default.

Content must place its elements inside a channel block — { "type": "channel", "channel": "email", "elements": [...] } — or the request returns 400. The template designer renders only the channel block matching the tab it draws, so content stored without one cannot be opened. An empty elements array is accepted, and the requirement applies to creation only: PUT /notifications/{id} still accepts unwrapped content. Note this endpoint takes versioned content only — the { title, body } shorthand accepted by /send is rejected here with an invalid_request_error on notification.content.version.

POST

notifications

JavaScript

import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const notificationTemplateResponse = await client.notifications.create({
  notification: {
    name: 'Welcome Email',
    tags: ['onboarding', 'welcome'],
    brand: { id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag' },
    subscription: { topic_id: 'pt_01kx4h2jdafq8bk9a26x0kvd1t' },
    routing: { strategy_id: 'rs_01kx4h2jdafq8bk9amzvy6hbv0' },
    content: { version: '2022-01-01', elements: [{ type: 'channel' }] },
    alias: 'welcome',
  },
  state: 'DRAFT',
});

console.log(notificationTemplateResponse);

import os
from courier import Courier

client = Courier(
    api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
)
notification_template_response = client.notifications.create(
    notification={
        "name": "Welcome Email",
        "tags": ["onboarding", "welcome"],
        "brand": {
            "id": "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"
        },
        "subscription": {
            "topic_id": "pt_01kx4h2jdafq8bk9a26x0kvd1t"
        },
        "routing": {
            "strategy_id": "rs_01kx4h2jdafq8bk9amzvy6hbv0"
        },
        "content": {
            "version": "2022-01-01",
            "elements": [{
                "type": "channel"
            }],
        },
        "alias": "welcome",
    },
    state="DRAFT",
)
print(notification_template_response)

package main

import (
	"context"
	"fmt"

	"github.com/trycourier/courier-go/v4"
	"github.com/trycourier/courier-go/v4/option"
	"github.com/trycourier/courier-go/v4/shared"
)

func main() {
	client := courier.NewClient(
		option.WithAPIKey("My API Key"),
	)
	notificationTemplateResponse, err := client.Notifications.New(context.TODO(), courier.NotificationNewParams{
		NotificationTemplateCreateRequest: courier.NotificationTemplateCreateRequestParam{
			Notification: courier.NotificationTemplateWritePayloadParam{
				NotificationTemplatePayloadParam: courier.NotificationTemplatePayloadParam{
					Brand: courier.NotificationTemplatePayloadBrandParam{
						ID: "bnd_01kx4mrd0pfzw8wt7pn7p2fzag",
					},
					Content: shared.ElementalContentParam{
						Elements: []shared.ElementalNodeUnionParam{{
							OfElementalTextNodeWithType: &shared.ElementalTextNodeWithTypeParam{
								ElementalTextNodeParam: shared.ElementalTextNodeParam{
									ElementalBaseNodeParam: shared.ElementalBaseNodeParam{},
								},
							},
						}},
						Version: "2022-01-01",
					},
					Name: "Welcome Email",
					Routing: courier.NotificationTemplatePayloadRoutingParam{
						StrategyID: "rs_01kx4h2jdafq8bk9amzvy6hbv0",
					},
					Subscription: courier.NotificationTemplatePayloadSubscriptionParam{
						TopicID: "pt_01kx4h2jdafq8bk9a26x0kvd1t",
					},
					Tags: []string{"onboarding", "welcome"},
				},
			},
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", notificationTemplateResponse)
}

package com.courier.example;

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.ElementalContent;
import com.courier.models.ElementalTextNodeWithType;
import com.courier.models.notifications.NotificationTemplateCreateRequest;
import com.courier.models.notifications.NotificationTemplatePayload;
import com.courier.models.notifications.NotificationTemplateResponse;
import com.courier.models.notifications.NotificationTemplateWritePayload;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        CourierClient client = CourierOkHttpClient.fromEnv();

        NotificationTemplateCreateRequest params = NotificationTemplateCreateRequest.builder()
            .notification(NotificationTemplateWritePayload.builder()
                .brand(NotificationTemplatePayload.Brand.builder()
                    .id("bnd_01kx4mrd0pfzw8wt7pn7p2fzag")
                    .build())
                .content(ElementalContent.builder()
                    .addElement(ElementalTextNodeWithType.builder().build())
                    .version("2022-01-01")
                    .build())
                .name("Welcome Email")
                .routing(NotificationTemplatePayload.Routing.builder()
                    .strategyId("rs_01kx4h2jdafq8bk9amzvy6hbv0")
                    .build())
                .subscription(NotificationTemplatePayload.Subscription.builder()
                    .topicId("pt_01kx4h2jdafq8bk9a26x0kvd1t")
                    .build())
                .addTag("onboarding")
                .addTag("welcome")
                .build())
            .build();
        NotificationTemplateResponse notificationTemplateResponse = client.notifications().create(params);
    }
}

require "courier"

courier = Courier::Client.new(api_key: "My API Key")

notification_template_response = courier.notifications.create(
  notification: {
    brand: {id: "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"},
    content: {elements: [{}], version: "2022-01-01"},
    name: "Welcome Email",
    routing: {strategy_id: "rs_01kx4h2jdafq8bk9amzvy6hbv0"},
    subscription: {topic_id: "pt_01kx4h2jdafq8bk9a26x0kvd1t"},
    tags: ["onboarding", "welcome"]
  }
)

puts(notification_template_response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Courier\Client;
use Courier\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');

try {
  $notificationTemplateResponse = $client->notifications->create(
    notification: [
      'brand' => ['id' => 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag'],
      'content' => [
        'elements' => [['type' => 'channel']], 'version' => '2022-01-01'
      ],
      'name' => 'Welcome Email',
      'routing' => ['strategyID' => 'rs_01kx4h2jdafq8bk9amzvy6hbv0'],
      'subscription' => ['topicID' => 'pt_01kx4h2jdafq8bk9a26x0kvd1t'],
      'tags' => ['onboarding', 'welcome'],
      'alias' => 'welcome',
    ],
    state: 'DRAFT',
    idempotencyKey: 'order-ORD-456-user-123',
    xIdempotencyExpiration: '1785312000',
  );

  var_dump($notificationTemplateResponse);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using TryCourier;
using TryCourier.Models;
using TryCourier.Models.Notifications;

CourierClient client = new();

NotificationCreateParams parameters = new()
{
    Notification = new()
    {
        Brand = new("bnd_01kx4mrd0pfzw8wt7pn7p2fzag"),
        Content = new()
        {
            Elements =
            [
                new ElementalChannelNodeWithType()
                {
                    Type = ElementalChannelNodeWithTypeIntersectionMember1Type.Channel,
                },
            ],
            Version = "2022-01-01",
        },
        Name = "Welcome Email",
        Routing = new("rs_01kx4h2jdafq8bk9amzvy6hbv0"),
        Subscription = new("pt_01kx4h2jdafq8bk9a26x0kvd1t"),
        Tags =
        [
            "onboarding", "welcome"
        ],
        Alias = "welcome",
    },
};

var notificationTemplateResponse = await client.Notifications.Create(parameters);

Console.WriteLine(notificationTemplateResponse);

courier notifications create \
  --api-key 'My API Key' \
  --notification "{brand: {id: bnd_01kx4mrd0pfzw8wt7pn7p2fzag}, content: {elements: [{}], version: '2022-01-01'}, name: Welcome Email, routing: {strategy_id: rs_01kx4h2jdafq8bk9amzvy6hbv0}, subscription: {topic_id: pt_01kx4h2jdafq8bk9a26x0kvd1t}, tags: [onboarding, welcome]}"

curl --request POST \
  --url https://api.courier.com/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notification": {
    "name": "Welcome Email",
    "tags": [
      "onboarding",
      "welcome"
    ],
    "brand": {
      "id": "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"
    },
    "subscription": {
      "topic_id": "pt_01kx4h2jdafq8bk9a26x0kvd1t"
    },
    "routing": {
      "strategy_id": "rs_01kx4h2jdafq8bk9amzvy6hbv0"
    },
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "Welcome!"
            },
            {
              "type": "text",
              "content": "Hello {{data.name}}."
            }
          ]
        }
      ]
    },
    "alias": "welcome"
  },
  "state": "DRAFT"
}
'

{
  "id": "nt_01kx4h2jdafq8bk9aftxak4b40",
  "name": "Welcome Email",
  "tags": [
    "onboarding",
    "welcome"
  ],
  "brand": {
    "id": "bnd_01kx4mrd0pfzw8wt7pn7p2fzag"
  },
  "subscription": {
    "topic_id": "pt_01kx4h2jdafq8bk9a26x0kvd1t"
  },
  "routing": {
    "strategy_id": "rs_01kx4h2jdafq8bk9amzvy6hbv0"
  },
  "content": {
    "version": "2022-01-01",
    "elements": [
      {
        "type": "channel",
        "channel": "email",
        "elements": [
          {
            "type": "meta",
            "title": "Welcome!"
          },
          {
            "type": "text",
            "content": "Hello {{data.name}}."
          }
        ]
      }
    ]
  },
  "alias": "welcome",
  "state": "DRAFT",
  "created": 1710000000000,
  "creator": "user_abc",
  "updated": 1710000000000,
  "updater": "user_abc"
}

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.

Body

application/json

Request body for creating a notification template.

notification

NotificationTemplateWritePayload · object

required

Template fields accepted in POST and PUT request bodies, nested under a notification key.

Show child attributes

state

enum<string>

default:DRAFT

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

Available options:

DRAFT,

PUBLISHED

Response

Created

Response for GET /notifications/{id}, POST /notifications, and PUT /notifications/{id}. Returns all template fields at the top level.

name

string

required

Display name for the template.

Send

Templates

Brands

Routing Strategies

Journeys

Broadcasts

User Profiles

Tenants

Audiences

Lists

Providers

Preference Topics

User Preferences

Messages

Device Tokens

Tenant Memberships

Tenant Templates

Bulk

Automations

Digests

Translations

Track Events

Audit Events

Authentication

Create Notification Template

Authorizations

Headers

Body

Response