> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Courier

The Courier connector lets your AI agent act in each user's Courier account. Each user connects their own Courier access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.

**Authentication:** Bearer Token
**Categories:** Communication, Marketing
**Tools:** 58: 24 read, 24 write, 10 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=COURIER)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Courier connection

   In **AgentKit > Connections**, create a Courier connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'courier'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Courier:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'courier_audiences_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "courier"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Courier:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="courier_audiences_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Courier credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'courier_audience_get',
  toolInput: {
    audience_id: '<audience_id>',
  },
  connector: 'courier',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="courier_audience_get",
    tool_input={
        "audience_id": "<audience_id>",
    },
    connection_name="courier",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `courier_audience_get`

Get an Audience · Read-only

Return one audience with its name, description, and the filter and AND or OR operator that decide which users belong to it.
Returns an object with id, name, description, operator, filter, created_at, updated_at.
Use this when you have the ID. Use courier_audiences_list to find one.
Needs audience_id from courier_audiences_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `audience_id` (`string`, required): A unique identifier representing the audience_id. Example: vip-customers

Example input: `{"audience_id":"<audience_id>"}`

### `courier_audience_members_list`

List Audience members · Read-only

Return the users currently matching an audience filter, with paging.
Returns items, an array of items with added_at, audience_id, audience_version, member_id, reason, plus paging.
Needs audience_id from courier_audiences_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `audience_id` (`string`, required): A unique identifier representing the audience id. Example: vip-customers
- `cursor` (`string`, optional): A unique identifier that allows for fetching the next set of members. Example: eyJpZCI6IjEyMyJ9

Example input: `{"audience_id":"<audience_id>"}`

### `courier_audiences_list`

List all Audiences · Read-only

Return the audiences in the workspace with paging.
Returns items, an array of items with id, name, description, operator, filter, created_at, updated_at, plus paging.
Use this to browse. Use courier_audience_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): A unique identifier that allows for fetching the next set of audiences. Example: eyJpZCI6IjEyMyJ9

Example input: `{}`

### `courier_automation_run_steps_list`

List steps for an Automation run · Read-only

List the per-step state of one Automation run, in full — this endpoint is not paginated.
Returns an object with steps.
Needs id from courier_automation_runs_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): A unique identifier representing the Automation run. Example: user-123

Example input: `{"id":"<id>"}`

### `courier_automation_runs_list`

List Automation runs · Read-only

List runs of the workspace's v2 Automations, newest first, filtered by status, Template, or date range and paged by cursor.
Returns an object with runs, next_cursor.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): A cursor token for pagination. Use the `next_cursor` from the previous response to fetch the next page of results. Treat it as opaque. Example: eyJpZCI6IjEyMyJ9
- `end_date` (`string`, optional): An inclusive upper bound on `created_at`, in the same format as `start_date`. Example: 2026-01-31T23:59:59Z
- `limit` (`string`, optional): The number of runs to return per page, between `1` and `50`. Defaults to `20`. Values outside the range are clamped, and a non-numeric value falls back to `20`. Example: 20
- `start_date` (`string`, optional): An inclusive lower bound on `created_at`, as an ISO 8601 date or timestamp (e.g. `2026-08-18` or `2026-08-18T20:06:36.259Z`). Any other format returns `400`. Example: 2026-01-01T00:00:00Z
- `status` (`string`, optional): A comma-separated list of run statuses to filter on, e.g. `PROCESSED,ERROR`. Example: active
- `template_id` (`string`, optional): A comma-separated list of Automation Template ids to filter on. Example: user-123

Example input: `{}`

### `courier_automations_list`

List Automations · Read-only

List the workspace's saved automation templates, each with its id and a cursor for paging to the next page of results.
Returns templates, an array of items with name, id, version, createdAt, updatedAt, plus cursor.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): A cursor token for pagination. Use the cursor from the previous response to fetch the next page of results. Example: eyJpZCI6IjEyMyJ9
- `version` (`string`, optional): The version of templates to retrieve. Accepted values are published (for published templates) or draft (for draft templates). Defaults to published. Example: published. One of: `published`, `draft`.

Example input: `{}`

### `courier_brand_get`

Get a Brand · Read-only

Return one brand by id, including its colors, logo and styling settings, Handlebars snippets, and published version.
Returns an object with id, name, published, created, updated, settings, snippets, version.
Use this when you have the ID. Use courier_brands_list to find one.
Needs brand_id from courier_brands_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `brand_id` (`string`, required): A unique identifier associated with the brand you wish to retrieve. Example: user-123

Example input: `{"brand_id":"<brand_id>"}`

### `courier_brands_list`

List Brands · Read-only

List the workspace's brands. Every entry carries its name, styling settings, snippets, and published version.
Returns results, an array of items with id, name, published, created, updated, settings, snippets, version, plus paging.
Use this to browse. Use courier_brand_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): A unique identifier that allows for fetching the next set of brands. Example: eyJpZCI6IjEyMyJ9

Example input: `{}`

### `courier_list_get`

Get a List · Read-only

Return one list by id with its name and created and updated timestamps.
Returns an object with id, name, created, updated.
Use this when you have the ID. Use courier_lists_list to find one.
Needs list_id from courier_lists_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest

Example input: `{"list_id":"<list_id>"}`

### `courier_list_subscriptions_list`

List List Subscribers · Read-only

Return the users subscribed to a list with paging, each with the preferences recorded for that subscription.
Returns items, an array of items with recipientId, created, preferences, plus paging.
Needs list_id from courier_lists_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest
- `cursor` (`string`, optional): A unique identifier that allows for fetching the next set of list subscriptions. Example: eyJpZCI6IjEyMyJ9

Example input: `{"list_id":"<list_id>"}`

### `courier_lists_list`

List Lists · Read-only

Return the workspace's lists, filterable by a pattern to fetch a subset such as every regional list.
Returns items, an array of items with id, name, created, updated, plus paging.
Use this to browse. Use courier_list_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): A unique identifier that allows for fetching the next page of lists. Example: eyJpZCI6IjEyMyJ9
- `pattern` (`string`, optional): "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `` to signify a wildcard `endsWith` pattern match.". Example: newsletter.*

Example input: `{}`

### `courier_message_content_get`

Get Message Content · Read-only

Return the rendered content Courier delivered for a message, broken out per channel, to confirm what the recipient received.
Returns results, an array of items with channel, channel_id, content.
Needs message_id from courier_messages_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): A unique identifier associated with the message you wish to retrieve (results from a send). Example: 1-65f1c2b3-4a5b6c7d8e9f0a1b2c3d4e5f

Example input: `{"message_id":"<message_id>"}`

### `courier_message_get`

Get message · Read-only

Return a sent message's status, recipient, event, and per-provider delivery detail, with timestamps for enqueued, sent, delivered, opened, and clicked.
Returns an object with providers, id, status, enqueued, sent, delivered, opened, clicked, recipient, event, notification, error and more.
Use this when you have the ID. Use courier_messages_list to find one.
Needs message_id from courier_messages_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): A unique identifier associated with the message you wish to retrieve (results from a send). Example: 1-65f1c2b3-4a5b6c7d8e9f0a1b2c3d4e5f

Example input: `{"message_id":"<message_id>"}`

### `courier_message_history_get`

Get Message History · Read-only

Return the ordered event history for a sent message, one entry per status transition with its timestamp.
Returns results, an array of items.
Needs message_id from courier_messages_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): A unique identifier representing the message ID. Example: 1-65f1c2b3-4a5b6c7d8e9f0a1b2c3d4e5f
- `type` (`string`, optional): A supported Message History type that will filter the events returned. Example: email

Example input: `{"message_id":"<message_id>"}`

### `courier_messages_list`

List messages · Read-only

Return previously sent messages, most recent first, each carrying its status, recipient, channel, and provider.
Returns results, an array of items with id, status, enqueued, sent, delivered, opened, clicked, recipient, event, notification, plus paging.
Use this to browse. Use courier_message_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `archived` (`boolean`, optional): A boolean value that indicates whether archived messages should be included in the response. Example: false
- `cursor` (`string`, optional): A unique identifier that allows for fetching the next set of messages. Example: eyJpZCI6IjEyMyJ9
- `enqueued_after` (`string`, optional): The enqueued datetime of a message to filter out messages received before. Example: eyJpZCI6IjEyMyJ9
- `event` (`string`, optional): A unique identifier representing the event that was used to send the event. Example: order-shipped
- `list` (`string`, optional): A unique identifier representing the list the message was sent to. Example: weekly-digest
- `messageId` (`string`, optional): A unique identifier representing the message_id returned from either /send or /send/list. Example: user-123
- `notification` (`string`, optional): A unique identifier representing the notification that was used to send the event. Example: nt_01abc23def
- `provider` (`array`, optional): The key assocated to the provider you want to filter on. E.g., sendgrid, inbox, twilio, slack, msteams, etc. Allows multiple values to be set in query parameters. Example: ["sendgrid"]
- `recipient` (`string`, optional): A unique identifier representing the recipient associated with the requested profile. Example: user-123
- `status` (`array`, optional): An indicator of the current status of the message. Allows multiple values to be set in query parameters. Example: ["DELIVERED"]
- `tag` (`array`, optional): A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters. Example: ["onboarding"]
- `tags` (`string`, optional): A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in. Example: onboarding
- `tenant_id` (`string`, optional): Messages sent with the context of a Tenant. Example: user-123
- `traceId` (`string`, optional): The unique identifier used to trace the requests. Example: user-123

Example input: `{}`

### `courier_profile_get`

Get a Profile · Read-only

Return a user's stored profile and preferences, including the email address, phone number, and push tokens Courier can reach them on.
Returns an object with profile, preferences.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): A unique identifier representing the user associated with the requested profile. Example: user-123

Example input: `{"user_id":"<user_id>"}`

### `courier_profile_lists_get`

Get Profile List Subscriptions · Read-only

Return the lists a user is subscribed to, with paging.
Returns results, an array of items with id, name, created, updated, preferences, plus paging.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): A unique identifier representing the user associated with the requested user profile. Example: user-123
- `cursor` (`string`, optional): A unique identifier that allows for fetching the next set of message statuses. Example: eyJpZCI6IjEyMyJ9

Example input: `{"user_id":"<user_id>"}`

### `courier_template_content_get`

Get Notification Template Content · Read-only

Return a template's content and checksum. V2 templates return Elemental elements, while V1 templates return blocks and channels instead.
Returns channels, an array of items with id, type, content, locales, checksum, plus version, elements, blocks, checksum.
Needs id from courier_templates_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Notification template ID (`nt_` prefix). Example: user-123
- `version` (`string`, optional): Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to `published`. Example: v3

Example input: `{"id":"<id>"}`

### `courier_template_get`

Get Notification Template · Read-only

Retrieve a notification template by ID. Returns the published version by default.
Returns an object with name, tags, brand, subscription, routing, content, email, alias, id, state, created, creator and more.
Use this when you have the ID. Use courier_templates_list to find one.
Needs id from courier_templates_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Template ID (nt_ prefix). Example: user-123
- `version` (`string`, optional): Version to retrieve. One of "draft", "published", or a version string like "v001". Defaults to "published". Example: draft

Example input: `{"id":"<id>"}`

### `courier_template_versions_list`

List Notification Template Versions · Read-only

Return a notification template's published versions, most recent first, for comparison or rollback.
Returns an object with versions, paging.
Needs id from courier_templates_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Template ID (nt_ prefix). Example: user-123
- `cursor` (`string`, optional): Opaque pagination cursor from a previous response. Omit for the first page. Example: eyJpZCI6IjEyMyJ9
- `limit` (`integer`, optional): Maximum number of versions to return per page. Default 10, max 10. Example: 20

Example input: `{"id":"<id>"}`

### `courier_templates_list`

List Notification Templates · Read-only

List the workspace's notification templates. Each carries a name, tags, brand, routing, and its draft or published state.
Returns results, an array of items with created_at, updated_at, id, routing, tags, title, topic_id, note, event_ids, name, plus paging.
Use this to browse. Use courier_template_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Opaque pagination cursor from a previous response. Omit for the first page. Example: eyJpZCI6IjEyMyJ9
- `event_id` (`string`, optional): Filter to templates linked to this event map ID. Example: user-123
- `notes` (`boolean`, optional): Include template notes in the response. Only applies to legacy templates. Example: false
- `tags` (`string`, optional): Comma-delimited list of tag names. Only templates carrying all of the listed tags are returned. Matching is case-insensitive. Filtering is applied before pagination. Example: onboarding

Example input: `{}`

### `courier_user_preference_get`

Get user Subscription Topic · Read-only

Return a user's opt-in status and channel choices for one subscription topic, or the effective default if they have set no override.
Returns an object with topic.
Use this when you have the ID. Use courier_user_preferences_list to find one.
Needs topic_id from courier_user_preferences_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `topic_id` (`string`, required): A unique identifier associated with a subscription topic. Example: 74Q4QGFBEX481DP6JRPMV751H4XT
- `user_id` (`string`, required): A unique identifier associated with the user whose preferences you wish to retrieve. Example: user-123
- `tenant_id` (`string`, optional): Query the preferences of a user for this specific tenant context. Example: user-123

Example input: `{"topic_id":"<topic_id>","user_id":"<user_id>"}`

### `courier_user_preferences_list`

Get user's Preferences · Read-only

Return a user's preference overrides with paging, one entry per subscription topic they have set a choice for.
Returns items, an array of items with custom_routing, default_status, has_custom_routing, section_id, section_name, status, topic_id, topic_name, digest_schedule_id, plus paging.
Use this to browse. Use courier_user_preference_get when you already have the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): A unique identifier associated with the user whose preferences you wish to retrieve. Example: user-123
- `tenant_id` (`string`, optional): Query the preferences of a user for this specific tenant context. Example: user-123

Example input: `{"user_id":"<user_id>"}`

### `courier_user_tokens_list`

List tokens · Read-only

Return every device token registered for a user, each with its provider key, status, and expiry date.
Returns an object with tokens.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): The user's ID. This can be any uniquely identifiable string. Example: user-123

Example input: `{"user_id":"<user_id>"}`

### `courier_audience_upsert`

Create or Update Audience · Write

Create or replace an audience from a filter and an AND or OR operator.
Returns an object with audience.
The request replaces the stored value with what you send.
Needs audience_id from courier_audiences_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `audience_id` (`string`, required): A unique identifier representing the audience id. Example: vip-customers
- `description` (`string`, optional): A description of the audience. Example: Users located in the US
- `filter` (`object`, optional): Filter configuration for audience membership containing an array of filter rules. Example: {"operator": "AND", "filters": [{"operator": "EQ", "path": "profile.location", "value": "US"}]}
- `name` (`string`, optional): The name of the audience. Example: Engaged US Users
- `operator` (`string`, optional): The logical operator (AND/OR) combining the top-level `filter.filters`. Convenience alias for `filter.operator`: if set, it is applied to the top-level filter group. Prefer setting `operator` directly inside `filter`. Example: AND. One of: `AND`, `OR`.

Example input: `{"audience_id":"<audience_id>"}`

### `courier_automation_invoke`

Invoke Automation Template · Write

Start an automation run from a saved template for one recipient, with optional data and profile, and returns a runId.
Returns an object with runId.
Needs templateId from courier_automations_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `recipient` (`string`, required): The user ID the automation runs for. Example: user-123
- `templateId` (`string`, required): A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias. Example: user-123
- `brand` (`string`, optional): The brand ID that styles the messages sent. Example: brand-123
- `data` (`object`, optional): Data passed to templates as variables. Example: {"order_id": "A-1001"}
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `profile` (`object`, optional): Profile fields to merge into the recipient's Courier profile for this run, such as email and phone_number. Example: {"email": "jane@example.com"}
- `template` (`string`, optional): The notification template ID or alias the automation steps should send. Example: nt_01abc23def
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"recipient":"<recipient>","templateId":"<templateId>"}`

### `courier_automation_invoke_ad_hoc`

Invoke Ad Hoc Automation · Write

Invoke an ad hoc Automation. Runs a series of automation steps supplied inline, without a saved template, and returns a runId.
Returns an object with runId.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `automation` (`object`, required): The ad hoc automation: a list of steps (send, delay, cancel and so on) and an optional cancelation_token. Example: {"steps": [{"action": "send", "template": "nt_01abc23def"}]}
- `brand` (`string`, optional): The brand ID that styles the messages sent. Example: brand-123
- `data` (`object`, optional): Data passed to templates as variables. Example: {"order_id": "A-1001"}
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `profile` (`object`, optional): Profile fields to merge into the recipient's Courier profile for this run, such as email and phone_number. Example: {"email": "jane@example.com"}
- `recipient` (`string`, optional): The user ID the automation runs for. Example: user-123
- `template` (`string`, optional): The notification template ID or alias the automation steps should send. Example: nt_01abc23def
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"automation":{}}`

### `courier_brand_create`

Create a new Brand · Write

Create a brand from a name and settings, including primary and secondary colors.
Returns an object with id, name, published, created, updated, settings, snippets, version.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Display name. Example: Acme
- `settings` (`object`, required): Brand settings: colors, email header and footer, and inbox styling. Example: {"colors": {"primary": "#1a73e8"}}
- `id` (`string`, optional): The brand ID to create. Leave empty to let Courier generate one. Example: brand-123
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `snippets` (`object`, optional): Reusable brand snippets (name and value pairs) that templates can reference. Example: {"items": [{"name": "footer", "value": "Acme Inc."}]}
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"name":"<name>","settings":{}}`

### `courier_brand_replace`

Replace a Brand · Write

Replace a brand with the values you supply, so send the complete settings and snippets rather than only the fields you want changed.
Returns an object with id, name, published, created, updated, settings, snippets, version.
The request replaces the stored value with what you send.
Needs brand_id from courier_brands_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `brand_id` (`string`, required): A unique identifier associated with the brand you wish to update. Example: user-123
- `name` (`string`, required): The name of the brand. Example: My Brand
- `settings` (`object`, optional): Brand settings: colors, email header and footer, and inbox styling. Example: {"colors": {"primary": "#1a73e8"}}
- `snippets` (`object`, optional): Reusable brand snippets (name and value pairs) that templates can reference. Example: {"items": [{"name": "footer", "value": "Acme Inc."}]}

Example input: `{"brand_id":"<brand_id>","name":"<name>"}`

### `courier_event_track`

Track Event · Write

Record an inbound event that can trigger a journey.
Returns an object with messageId.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event` (`string`, required): A descriptive name of the event. This name will appear as a trigger in the Courier Automation Trigger node. Example: order-shipped
- `messageId` (`string`, required): A required unique identifier that will be used to de-duplicate requests. If not unique, will respond with 409 Conflict status. Example: 4c62c457-b329-4bea-9bfc-17bba86c393f
- `properties` (`object`, required): Event properties passed to automations and templates. Example: {"order_id": "A-1001"}
- `type` (`string`, required): The event type. For inbound tracking this is track. Example: track. One of: `track`.
- `userId` (`string`, optional): The user id associated with the track. Example: 1234

Example input: `{"event":"<event>","messageId":"<messageId>","properties":{"order_id":"A-1001"},"type":"track"}`

### `courier_list_restore`

Restore a List · Write

Restore a previously deleted list along with its subscribers, so a list removed by mistake can be brought back rather than rebuilt.
Returns an empty response on success (HTTP 204).
Needs list_id from courier_lists_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest

Example input: `{"list_id":"<list_id>"}`

### `courier_list_subscribers_add`

Add Subscribers to List · Write

Subscribe additional users to the list, without modifying existing subscriptions.
Returns an empty response on success (HTTP 202).
Needs list_id from courier_lists_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest
- `recipients` (`array`, required): The users to subscribe, each with a recipientId and optional per-list preferences. Example: [{"recipientId": "user-123"}]
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"list_id":"<list_id>","recipients":[{"recipientId":"user-123"}]}`

### `courier_list_subscribers_replace`

Replace List Subscribers · Write

Subscribe the users to the list, overwriting existing subscriptions.
Returns an empty response on success (HTTP 202).
The request replaces the stored value with what you send.
Needs list_id from courier_lists_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest
- `recipients` (`array`, required): The users to subscribe, each with a recipientId and optional per-list preferences. Example: [{"recipientId": "user-123"}]

Example input: `{"list_id":"<list_id>","recipients":[{"recipientId":"user-123"}]}`

### `courier_list_upsert`

Create or Update List · Write

Create or replace a list from a name and preferences.
Returns an empty response on success (HTTP 204).
The request replaces the stored value with what you send.
Needs list_id from courier_lists_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest
- `name` (`string`, required): Display name. Example: Acme
- `preferences` (`object`, optional): Notification preferences for this list subscription, keyed by notification or category. Example: {"notifications": {}}

Example input: `{"list_id":"<list_id>","name":"<name>"}`

### `courier_list_user_subscribe`

Subscribe User to List · Write

Subscribe one user to a list, creating the list if it does not yet exist.
Returns an empty response on success (HTTP 204).
Needs list_id from courier_lists_list; user_id from courier_list_subscriptions_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest
- `user_id` (`string`, required): A unique identifier representing the recipient associated with the list. Example: user-123
- `preferences` (`object`, optional): Notification preferences for this list subscription, keyed by notification or category. Example: {"notifications": {}}

Example input: `{"list_id":"<list_id>","user_id":"<user_id>"}`

### `courier_message_resend`

Resend message · Write

Resend a previously sent message to the same recipient and content, returning a new messageId.
Returns an object with messageId.
Needs message_id from courier_messages_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `message_id` (`string`, required): A unique identifier representing the message ID of the original message to resend. Example: 1-65f1c2b3-4a5b6c7d8e9f0a1b2c3d4e5f

Example input: `{"message_id":"<message_id>"}`

### `courier_message_send`

Send Message · Write

Send a message to one or more recipients (a user ID, email, phone number, list, audience or tenant) using a stored template or inline content; Courier routes it to email, SMS, push, chat or inbox by your routing rules.
Returns requestId, which ties together every message the send produces.
Use this to send now. Use courier_messages_list or courier_message_get with the requestId to check delivery, and courier_automation_invoke for multi-step flows.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `message` (`object`, required): Defines the message to be delivered. Example: {"to": {"email": "jane@example.com"}, "content": {"title": "Your order shipped", "body": "Order A-1001 is on its way."}, "routing": {"method": "single", "channels": ["email"]}}
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"message":{}}`

### `courier_profile_lists_subscribe`

Subscribe Profile to Lists · Write

Subscribe a user to one or more lists, creating any list that does not yet exist.
Returns an object with status.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `lists` (`array`, required): The lists to subscribe the profile to, each with a listId and optional preferences. Example: [{"listId": "weekly-digest"}]
- `user_id` (`string`, required): A unique identifier representing the user associated with the requested user profile. Example: user-123
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"lists":[{"listId":"weekly-digest"}],"user_id":"<user_id>"}`

### `courier_profile_merge`

Create or Merge Profile · Write

Merge the supplied values into a user's profile, creating it if absent and leaving any key you omit untouched.
Returns an object with status.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `profile` (`object`, required): Profile fields to merge into the recipient's Courier profile for this run, such as email and phone_number. Example: {"email": "jane@example.com"}
- `user_id` (`string`, required): A unique identifier representing the user associated with the requested profile. Example: user-123
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"profile":{"email":"jane@example.com"},"user_id":"<user_id>"}`

### `courier_profile_patch`

Patch Profile · Write

Apply a JSON Patch to a user profile, adding, removing, or replacing individual fields without sending the whole object.
Returns an empty response on success (HTTP 204).
Only the fields you pass change; omitted fields keep their current values.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `patch` (`array`, required): List of patch operations to apply to the profile. Example: [{"op": "replace", "path": "/email", "value": "jdoe@example.com"}]
- `user_id` (`string`, required): A unique identifier representing the user associated with the requested user profile. Example: user-123

Example input: `{"patch":[{"op":"replace","path":"/email","value":"jdoe@example.com"}],"user_id":"<user_id>"}`

### `courier_profile_replace`

Replace a Profile · Write

Replace a Profile. Overwrites a user profile in full, removing any key absent from the request body.
Returns an object with status.
The request replaces the stored value with what you send.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile` (`object`, required): The complete profile to store for this user. It replaces the stored profile: any field you leave out, such as phone_number, is removed. To change only some fields, use courier_profile_merge or courier_profile_patch. Example: {"email": "jane@example.com", "phone_number": "+15558675309"}
- `user_id` (`string`, required): A unique identifier representing the user associated with the requested user profile. Example: user-123

Example input: `{"profile":{"email":"jane@example.com","phone_number":"+15558675309"},"user_id":"<user_id>"}`

### `courier_request_archive`

Archive Request · Write

Archive a send request by its request id. Use it to remove test sends or superseded requests from the message list without deleting them.
Returns an empty response on success (HTTP 202).

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `request_id` (`string`, required): A unique identifier representing the request ID. Example: user-123

Example input: `{"request_id":"<request_id>"}`

### `courier_template_content_replace`

Replace Notification Template Content · Write

Replace all Elemental content in a template, overwriting every existing element.
Returns an object with id, version, elements, state.
The request replaces the stored value with what you send.
Needs id from courier_templates_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `content` (`object`, required): Elemental content payload. The server defaults `version` when omitted. Example: {"elements": [{"type": "text"}]}
- `id` (`string`, required): Notification template ID (`nt_` prefix). Example: user-123
- `state` (`string`, optional): Template state. Defaults to `DRAFT`. Example: DRAFT. One of: `DRAFT`, `PUBLISHED`.

Example input: `{"content":{},"id":"<id>"}`

### `courier_template_create`

Create Notification Template · Write

Create a notification template. Requires all fields in the notification object.
Returns an object with name, tags, brand, subscription, routing, content, email, alias, id, state, created, creator and more.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `notification` (`object`, required): Template fields accepted in POST and PUT request bodies, nested under a `notification` key. Example: {"name": "Welcome Email", "tags": ["onboarding"], "brand": null, "subscription": null, "routing": null, "content": {"version": "2022-01-01", "elements": [{"type": "channel", "channel": "email", "elements": [{"type": "meta", "title": "Welcome!"}, {"type": "text", "content": "Thanks for signing up."}]}]}, "alias": "welcome"}
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `state` (`string`, optional): Template state after creation. Case-insensitive input, normalized to uppercase in the response. Defaults to "DRAFT". Example: DRAFT. One of: `DRAFT`, `PUBLISHED`.
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"notification":{}}`

### `courier_template_publish`

Publish Notification Template · Write

Publish a notification template. Publishes the current draft by default.
Returns an empty response on success (HTTP 204).
Needs id from courier_templates_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Template ID (nt_ prefix). Example: user-123
- `idempotency_key` (`string`, optional): 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. Example: order-ORD-456-user-123
- `version` (`string`, optional): Historical version to publish (e.g. "v001"). Omit to publish the current draft. Example: v3
- `x_idempotency_expiration` (`string`, optional): 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. Example: 1785312000

Example input: `{"id":"<id>"}`

### `courier_template_replace`

Replace Notification Template · Write

Replace a notification template in full, so send every field rather than only the ones you want changed.
Returns an object with name, tags, brand, subscription, routing, content, email, alias, id, state, created, creator and more.
The request replaces the stored value with what you send.
Needs id from courier_templates_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Template ID (nt_ prefix). Example: user-123
- `notification` (`object`, required): Template fields accepted in POST and PUT request bodies, nested under a `notification` key. Example: {"name": "Welcome Email", "tags": ["onboarding"], "brand": null, "subscription": null, "routing": null, "content": {"version": "2022-01-01", "elements": [{"type": "channel", "channel": "email", "elements": [{"type": "meta", "title": "Welcome!"}, {"type": "text", "content": "Thanks for signing up."}]}]}, "alias": "welcome"}
- `state` (`string`, optional): Template state after update. Case-insensitive input, normalized to uppercase in the response. Defaults to "DRAFT". Example: PUBLISHED. One of: `DRAFT`, `PUBLISHED`.

Example input: `{"id":"<id>","notification":{}}`

### `courier_user_preference_update`

Update User Topic Preference · Write

Set a user's opt-in status and channel choices for one subscription topic, overriding the tenant default for that topic only.
Returns an object with message.
The request replaces the stored value with what you send.
Needs topic_id from courier_user_preferences_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `topic` (`object`, required): The preference for this subscription topic: status (OPTED_IN, OPTED_OUT or REQUIRED) and optional custom routing. Example: {"status": "OPTED_OUT"}
- `topic_id` (`string`, required): A unique identifier associated with a subscription topic. Example: 74Q4QGFBEX481DP6JRPMV751H4XT
- `user_id` (`string`, required): A unique identifier associated with the user whose preferences you wish to retrieve. Example: abc-123
- `tenant_id` (`string`, optional): Update the preferences of a user for this specific tenant context. Example: user-123

Example input: `{"topic":{"status":"OPTED_OUT"},"topic_id":"<topic_id>","user_id":"<user_id>"}`

### `courier_user_token_add`

Add User Device Token · Write

Register one device token for a user against a provider key, overwriting the token if it already exists.
Returns an empty response on success (HTTP 204).
Needs token from courier_user_tokens_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `provider_key` (`string`, required): The push provider for this token: firebase-fcm, apn, expo or onesignal. Example: firebase-fcm. One of: `firebase-fcm`, `apn`, `expo`, `onesignal`.
- `token` (`string`, required): The full token string. Example: fcm-token-abc123
- `user_id` (`string`, required): The user's ID. This can be any uniquely identifiable string. Example: user-123
- `device` (`object`, optional): Information about the device the token came from. Example: {"app_id": "com.example.app"}
- `expiry_date` (`boolean`, optional): When the token expires. Accepts a date, or the boolean `false` to disable expiration entirely. ISO 8601 is recommended (for example `2026-10-25T00:00:00.000Z`). A value that cannot be parsed as a date is rejected; it is not treated as "no expiration" and does not fall back to the default. `true` is not a supported value. Omit the field to use the default, which expires a token that has not been re-registered for 60 days. Example: 2027-01-01T00:00:00Z
- `properties` (`string`, optional): Properties about the token. Example: {"app": "ios"}
- `tracking` (`object`, optional): Tracking information about the device the token came from. Example: {"os_version": "17.2", "ip": "203.0.113.10"}

Example input: `{"provider_key":"firebase-fcm","token":"<token>","user_id":"<user_id>"}`

### `courier_audience_delete`

Delete an Audience · Destructive

Delete an audience permanently, so update any caller sending to it by audience id first.
Returns an empty response on success (HTTP 204).
Needs audience_id from courier_audiences_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `audience_id` (`string`, required): A unique identifier representing the audience id. Example: vip-customers

Example input: `{"audience_id":"<audience_id>"}`

### `courier_brand_delete`

Delete a Brand · Destructive

Delete a brand by id. Reassign any template or tenant that references it before deleting to keep their styling intact.
Returns an empty response on success (HTTP 204).
Needs brand_id from courier_brands_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `brand_id` (`string`, required): A unique identifier associated with the brand you wish to retrieve. Example: user-123

Example input: `{"brand_id":"<brand_id>"}`

### `courier_list_delete`

Delete a List · Destructive

Delete a list, halting sends that target it. A previously deleted list can be brought back with the companion restore endpoint.
Returns an empty response on success (HTTP 204).
Needs list_id from courier_lists_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest

Example input: `{"list_id":"<list_id>"}`

### `courier_list_user_unsubscribe`

Unsubscribe User from List · Destructive

Remove one user's subscription to a list, addressed by list id and user id.
Returns an empty response on success (HTTP 204).
Needs list_id from courier_lists_list; user_id from courier_list_subscriptions_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): A unique identifier representing the list you wish to retrieve. Example: weekly-digest
- `user_id` (`string`, required): A unique identifier representing the recipient associated with the list. Example: user-123

Example input: `{"list_id":"<list_id>","user_id":"<user_id>"}`

### `courier_message_cancel`

Cancel message · Destructive

Cancel a message that is still queued or delayed (for example inside a digest or a delay step) so it is not delivered.
Returns the message with its updated status.
Use courier_messages_list to find the message_id. A message already sent cannot be recalled.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `message_id` (`string`, required): A unique identifier representing the message ID. Example: 1-65f1c2b3-4a5b6c7d8e9f0a1b2c3d4e5f

Example input: `{"message_id":"<message_id>"}`

### `courier_profile_delete`

Delete a Profile · Destructive

Delete a user's profile and stored contact details.
Returns an empty response on success (HTTP 204).

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): A unique identifier representing the user associated with the requested user profile. Example: user-123

Example input: `{"user_id":"<user_id>"}`

### `courier_profile_lists_unsubscribe_all`

Remove Profile from All Lists · Destructive

Remove every list subscription for a user at once.
Returns an object with status.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `user_id` (`string`, required): A unique identifier representing the user associated with the requested profile. Example: user-123

Example input: `{"user_id":"<user_id>"}`

### `courier_template_archive`

Archive Notification Template · Destructive

Archive a notification template, preventing new sends from referencing it.
Returns an empty response on success (HTTP 204).
Needs id from courier_templates_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Template ID (nt_ prefix). Example: user-123

Example input: `{"id":"<id>"}`

### `courier_user_preference_delete`

Delete User Topic Preference · Destructive

Remove a user's override for one subscription topic, resetting it to the effective default from the tenant or workspace.
Returns an empty response on success (HTTP 204).
Needs topic_id from courier_user_preferences_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `topic_id` (`string`, required): A unique identifier associated with a subscription topic. Example: 74Q4QGFBEX481DP6JRPMV751H4XT
- `user_id` (`string`, required): A unique identifier associated with the user whose preferences you wish to delete. Example: abc-123
- `tenant_id` (`string`, optional): Delete the preferences of a user for this specific tenant context. Example: user-123

Example input: `{"topic_id":"<topic_id>","user_id":"<user_id>"}`

### `courier_user_token_delete`

Delete User Device Token · Destructive

Delete one device token for a user, addressed by the token value, so push sends no longer target that device.
Returns an empty response on success (HTTP 204).
Needs token from courier_user_tokens_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `token` (`string`, required): The full token string. Example: fcm-token-abc123
- `user_id` (`string`, required): The user's ID. This can be any uniquely identifiable string. Example: user-123

Example input: `{"token":"<token>","user_id":"<user_id>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
