Manage templates via the API

Create, update, publish, and manage notification templates over Courier’s Templates API. Each template stores Elemental content and reusable routing, the same assets you edit in Design Studio.

The Templates API tutorial walks through create, publish, and send end-to-end with working code.

Endpoints

Authenticate every request with your workspace API key as a Bearer token: Authorization: Bearer <token>.

Endpoint	Purpose
`GET /notifications`	List templates.
`POST /notifications`	Create a template.
`GET /notifications/{id}`	Get one template.
`PUT /notifications/{id}`	Replace a template in full.
`PUT /notifications/{id}/content`	Update the draft content.
`GET /notifications/{id}/draft/content`	Read draft content.
`GET /notifications/{id}/content`	Read published content.
`POST /notifications/{id}/publish`	Publish a draft.
`DELETE /notifications/{id}`	Archive a template.

Create a template

Send POST /notifications with a notification object and an optional state flag (defaults to DRAFT). Set COURIER_API_KEY in your environment first.

curl -X POST https://api.courier.com/notifications \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "DRAFT",
    "notification": {
      "name": "Order shipped",
      "routing": null,
      "content": {
        "version": "2022-01-01",
        "elements": [
          { "type": "meta", "title": "Your order {{order_id}} shipped" },
          { "type": "text", "content": "Hi {{name}}, tracking: {{tracking_url}}." },
          { "type": "action", "content": "Track", "href": "{{tracking_url}}" }
        ]
      }
    }
  }'

// npm install @trycourier/courier
import Courier from "@trycourier/courier";

const courier = new Courier();

const template = await courier.notifications.create({
  state: "DRAFT",
  notification: {
    name: "Order shipped",
    routing: null,
    content: {
      version: "2022-01-01",
      elements: [
        { type: "meta", title: "Your order {{order_id}} shipped" },
        { type: "text", content: "Hi {{name}}, tracking: {{tracking_url}}." },
        { type: "action", content: "Track", href: "{{tracking_url}}" },
      ],
    },
  },
});

console.log(template.id); // nt_...

# pip install trycourier
from courier import Courier

courier = Courier()

template = courier.notifications.create(
    state="DRAFT",
    notification={
        "name": "Order shipped",
        "routing": None,
        "content": {
            "version": "2022-01-01",
            "elements": [
                {"type": "meta", "title": "Your order {{order_id}} shipped"},
                {"type": "text", "content": "Hi {{name}}, tracking: {{tracking_url}}."},
                {"type": "action", "content": "Track", "href": "{{tracking_url}}"},
            ],
        },
    },
)

print(template.id)  # nt_...

The notification object has two parts you’ll set most often:

routing: which channels and providers to use. Pass null to skip it for now, or { "strategy_id": "rs_..." } to attach an existing strategy.
content: the notification body, written in Elemental, Courier’s JSON templating format. A version plus an elements array of blocks like meta, text, action, and channel.

Update, publish, and read

Update: PUT /notifications/{id}/content updates the draft body. PUT /notifications/{id} replaces the whole template.
Publish: POST /notifications/{id}/publish promotes the current draft (or a specific version) to live.
Read: GET /notifications/{id}/draft/content returns the draft body, and GET /notifications/{id}/content returns the published body.

Add HTML to a template

To author HTML through the API, for example when porting a legacy email, put a complete HTML document on the email channel node’s raw.html with the handlebars transformer. The meta title sets the subject.

{
  "version": "2022-01-01",
  "elements": [
    {
      "type": "channel",
      "channel": "email",
      "elements": [
        { "type": "meta", "title": "Your order {{order_id}} shipped" }
      ],
      "raw": {
        "transformers": ["handlebars"],
        "html": "<!DOCTYPE html><html><body><h1>Hi {{name}}</h1><p>Tracking: {{tracking_url}}</p></body></html>"
      }
    }
  ]
}

Next steps

Templates API tutorial

Create, publish, and send end-to-end.

Elemental overview

How Elemental documents are structured.

HTML blocks

Inline and whole-email HTML in email.

Routing configuration

Attach channels and providers to a template.

Platform

Developer Tools

Help

Manage templates via the API

Endpoints

Create a template

Update, publish, and read

Add HTML to a template

Next steps

Templates API tutorial

Elemental overview

HTML blocks

Routing configuration

​Endpoints

​Create a template

​Update, publish, and read

​Add HTML to a template

​Next steps

Templates API tutorial

Elemental overview

HTML blocks

Routing configuration

Endpoints

Create a template

Update, publish, and read

Add HTML to a template

Next steps