Localization

Courier supports sending notifications in multiple languages. You can localize content using:

Manual approaches: Create language-specific channels or templates in the designer
Variable-based: Pass translated content in your send request
API-driven: Use the localization API directly or integrate with a translation management system (TMS)

For a step-by-step walkthrough, see How to Internationalize Notifications.

Setting a User’s Locale

Include a locale property in the user’s profile or in the send request:

{
  "message": {
    "to": {
      "email": "user@example.com",
      "locale": "fr_FR"
    },
    "template": "TEMPLATE_ID",
    "data": {
      "name": "Jane"
    }
  }
}

The locale value should follow ISO 639-1 format (e.g., en, en_US, fr, fr_FR, de_DE).

Previewing Localized Content

Include a locale in your test event’s profile to preview the localized version:

Without a locale in the test event, the preview shows the default (source) language.

API-Driven Localization

API-driven localization is available on Business and Enterprise plans.

Courier provides APIs to programmatically manage translations, either for direct scripting or integration with a translation management system (TMS).

Key Concepts

Concept	Description
Blocks	Individual content pieces (text, action, list, etc.) that can have locale-specific versions
Channels	Channel-specific content (email subject, push title) that can be localized
Checksum	MD5 hash to track content changes and manage translation workflows
Locales	Language/region codes (e.g., `fr_FR`, `de_DE`) used to store translations

Supported Block Types

Block Type	Content Structure
Text	Plain string with variables and highlights
Quote	Plain string with variables and highlights
Markdown	Markdown string with variables
Action	Button text string
List	Object with `parent` and `children` strings
Template	HTML string

Draft vs Published Paths

Every localization endpoint is available at two paths:

Path style	Behavior
`/notifications/{id}/...`	Updates the published template directly. Changes are live immediately.
`/notifications/{id}/draft/...`	Updates the draft version. Requires a publish step before changes go live.

For programmatic locale updates (scripts, CI/CD, bulk imports), the non-draft paths are simpler since they skip the publish step entirely. Use the draft paths when you need a review or approval step before translations go live, or when integrating with a TMS.

API Endpoints

Method	Published Path	Draft Path	Description
`GET`	`/notifications/{id}/content`	`/notifications/{id}/draft/content`	Fetch translatable content (blocks, channels, existing locales)
`PUT`	`/notifications/{id}/locales`	`/notifications/{id}/draft/locales`	Bulk-update locales for all blocks and channels
`PUT`	`/notifications/{id}/locales/{locale}`	`/notifications/{id}/draft/locales/{locale}`	Update all blocks/channels for a single locale
`POST`	`/notifications/{id}/blocks/{blockId}/locales`	`/notifications/{id}/draft/blocks/{blockId}/locales`	Update locales for a specific block
`POST`	`/notifications/{id}/channels/{channelId}/locales`	`/notifications/{id}/draft/channels/{channelId}/locales`	Update locales for a specific channel

All endpoints require an Authorization: Bearer {api_key} header.

Step 1: Fetch Translatable Content

Start by fetching your template’s content to get the block and channel IDs you’ll need for the update endpoints.

curl -X GET https://api.courier.com/notifications/{notification_id}/content \
  -H "Authorization: Bearer $COURIER_API_KEY"

Response:

{
  "blocks": [
    {
      "id": "block_43c114d9-9cfd-4340-808f-17e2fc7a4c87",
      "type": "text",
      "content": "Hello <variable id=\"3\">{name}</variable>, Welcome to Courier!",
      "checksum": "fb60f2098fa407a4ff8d48e3e908d889",
      "locales": {
        "fr_FR": "Bonjour <variable id=\"3\">{name}</variable>, bienvenu à Courier!"
      }
    }
  ],
  "channels": [
    {
      "id": "channel_456",
      "type": "email",
      "content": { "subject": "Welcome!" },
      "checksum": "a1b2c3d4...",
      "locales": {
        "fr_FR": { "subject": "Bienvenue !" }
      }
    }
  ]
}

When updating translations, preserve the <variable> and <highlight> tags with their original IDs. These are required for proper variable substitution.

Step 2: Update Translations

Choose the approach that fits your workflow.

Option A: Update locales for a specific block

Use the block ID from the content response to update translations for a single block.

curl -X POST https://api.courier.com/notifications/{notification_id}/blocks/{block_id}/locales \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fr_FR": "Bonjour <variable id=\"3\">{name}</variable>, bienvenu à Courier!",
    "de_DE": "Hallo <variable id=\"3\">{name}</variable>, willkommen bei Courier!"
  }'

Returns 204 No Content on success. For list blocks, the body uses an object with parent and children keys instead of a plain string:

{
  "fr_FR": { "parent": "Éléments de la commande", "children": "{item} × {qty}" },
  "de_DE": { "parent": "Bestellpositionen", "children": "{item} × {qty}" }
}

Option B: Update locales for a specific channel

Use the channel ID from the content response to update channel-level translations (e.g., email subject, push title). The body is a plain string per locale; the backend automatically maps the value to subject for email channels or title for push channels based on the channel type.

curl -X POST https://api.courier.com/notifications/{notification_id}/channels/{channel_id}/locales \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fr_FR": "Bienvenue !",
    "de_DE": "Willkommen!"
  }'

Returns 204 No Content on success.

The per-channel endpoint takes a plain string per locale. For email channels, this sets the subject line. For push channels, it sets the title. The bulk update endpoint uses a different format where you specify { "subject": "..." } or { "title": "..." } explicitly.

Option C: Bulk-update all locales at once

Update translations for all blocks and channels in a single request.

curl -X PUT https://api.courier.com/notifications/{notification_id}/locales \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "blocks": [
      {
        "id": "block_43c114d9-9cfd-4340-808f-17e2fc7a4c87",
        "type": "text",
        "locales": {
          "fr_FR": "Bonjour <variable id=\"3\">{name}</variable>, bienvenu à Courier!",
          "de_DE": "Hallo <variable id=\"3\">{name}</variable>, willkommen bei Courier!"
        }
      }
    ],
    "channels": [
      {
        "id": "channel_456",
        "locales": {
          "fr_FR": { "subject": "Bienvenue !" },
          "de_DE": { "subject": "Willkommen!" }
        }
      }
    ]
  }'

Returns 204 No Content on success.

Publishing Draft Changes

If you use the /draft/ endpoints, your translations are saved to the draft version and need to be published before they take effect. Two options: Option 1: Direct publish (simplest)

curl -X POST https://api.courier.com/notifications/{notification_id}/publish \
  -H "Authorization: Bearer $COURIER_API_KEY"

Option 2: TMS checks workflow If your template was submitted for translation via the Studio UI, you can complete the submission by resolving all checks. This auto-publishes the draft when every check is resolved.

curl -X PUT https://api.courier.com/notifications/{notification_id}/{submission_id}/checks \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "checks": [{ "id": "custom", "status": "RESOLVED", "type": "custom" }]
  }'

If you don’t need a review step, skip the draft paths entirely. The non-draft endpoints update the published template directly with no publish step required.

TMS Integration Workflow

For teams using a translation management system, Courier supports a webhook-driven workflow:

Submit for translation: When a template is submitted in Studio, Courier sends a notification:submitted webhook
Fetch content: Your TMS fetches translatable content via GET /notifications/{id}/draft/content
Update translations: Push translated content back via the /draft/ locale endpoints
Complete the process: Resolve checks via PUT /notifications/{id}/{submissionId}/checks to auto-publish

Webhooks

Configure webhooks in Settings → Webhooks to receive events for the TMS workflow:

notification:submitted — Template submitted for translation
notification:published — Template published
notification:canceled — Submission canceled

Internationalizing Notifications

Step-by-step tutorial for sending multi-language notifications.

Elemental Locales

Localize Elemental templates programmatically.

Send Conditions

Route to channels based on locale.

Handlebars Formatting

Format dates and numbers for locales.

Platform

Developer Tools

Help

Setting a User’s Locale

Previewing Localized Content

API-Driven Localization

Key Concepts

Supported Block Types

Draft vs Published Paths

API Endpoints

Step 1: Fetch Translatable Content

Step 2: Update Translations

Option A: Update locales for a specific block

Option B: Update locales for a specific channel

Option C: Bulk-update all locales at once

Publishing Draft Changes

TMS Integration Workflow

Webhooks

Internationalizing Notifications

Elemental Locales

Send Conditions

Handlebars Formatting

Platform

Developer Tools

Help

​Setting a User’s Locale

​Previewing Localized Content

​API-Driven Localization

​Key Concepts

​Supported Block Types

​Draft vs Published Paths

​API Endpoints

​Step 1: Fetch Translatable Content

​Step 2: Update Translations

​Option A: Update locales for a specific block

​Option B: Update locales for a specific channel

​Option C: Bulk-update all locales at once

​Publishing Draft Changes

​TMS Integration Workflow

​Webhooks

​Related Resources

Internationalizing Notifications

Elemental Locales

Send Conditions

Handlebars Formatting

Setting a User’s Locale

Previewing Localized Content

API-Driven Localization

Key Concepts

Supported Block Types

Draft vs Published Paths

API Endpoints

Step 1: Fetch Translatable Content

Step 2: Update Translations

Option A: Update locales for a specific block

Option B: Update locales for a specific channel

Option C: Bulk-update all locales at once

Publishing Draft Changes

TMS Integration Workflow

Webhooks

Related Resources