> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/courier.md).

# Courier

Send notifications and manage Courier message logs and user profiles.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector         | Authentication      |
| ----------------- | ------------------- |
| Courier (API Key) | Environment API Key |

#### Courier (API Key)

Connect a Courier environment to send notifications, inspect message logs, cancel queued messages, and manage user profiles.

**Set up in Courier**

1. Prepare the Courier account or service that the workflow will access. Grant access to the required resources and operations.
2. **Environment API Key:** In Courier, select the intended environment, open Settings > API Keys, and copy a key. Use a Test environment key while validating this integration.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Courier (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field       | Required | What to enter                                                                                                                                                                                                            |
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Environment API Key | Yes      | In Courier, select the intended environment, open Settings > API Keys, and copy a key. Use a Test environment key while validating this integration. [Provider instructions](https://app.courier.com/settings/api-keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Courier** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Send Notification Message

Send one notification through Courier with duplicate-send protection.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                    |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Recipient Type   | select (string) | Yes      | How Courier should identify the recipient. Available values: Courier user ID, Email address, Phone number. Default: user\_id.  |
| Recipient        | string          | Yes      | User ID, email address, or E.164 phone number.                                                                                 |
| Content          | select (string) | Yes      | Write content here or use a Courier template. Available values: Write inline content, Use a Courier template. Default: inline. |
| Title            | string          | Yes      | Notification title or subject.                                                                                                 |
| Body             | textarea        | Yes      | Notification body.                                                                                                             |
| Template         | string          | Yes      | Published Courier template ID or alias.                                                                                        |
| Channel Override | select (string) | No       | Delivery channel for inline content, or an optional template routing override. Available values: Email, Sms, Inbox, Push.      |
| Template Data    | textarea        | No       | Optional JSON object for content variables.                                                                                    |
| Idempotency Key  | string          | Yes      | Stable key that prevents duplicate sends.                                                                                      |

**Outputs**

| Field      | Type   | Description                      |
| ---------- | ------ | -------------------------------- |
| Message ID | string | Courier request ID for tracking. |

#### Send Bulk Messages

Create, populate, and run a Courier bulk notification job.

**Inputs**

| Field             | Type     | Required | Description                                                 |
| ----------------- | -------- | -------- | ----------------------------------------------------------- |
| Event             | string   | Yes      | Courier event or notification ID for the bulk job.          |
| Recipient IDs     | textarea | Yes      | Comma-separated Courier user IDs, up to 1,000.              |
| Recipient Emails  | textarea | No       | Optional comma-separated emails aligned with recipient IDs. |
| Template Override | string   | No       | Optional Courier template override.                         |
| Shared Data       | textarea | No       | JSON data shared by every recipient.                        |
| Idempotency Key   | string   | Yes      | Stable key preventing duplicate job execution.              |

**Outputs**

| Field       | Type    | Description                      |
| ----------- | ------- | -------------------------------- |
| Bulk Job ID | string  | Courier bulk job ID.             |
| Recipients  | integer | Number of recipients ingested.   |
| Status      | string  | Initial asynchronous job status. |

#### List Messages

List Courier message logs with delivery filters and cursor pagination.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                                                                           |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Message ID       | string          | No       | Look up one message by the ID returned when it was sent.                                                                                                                                              |
| Recipient        | string          | No       | Filter by recipient ID or address.                                                                                                                                                                    |
| Event            | string          | No       | Filter by send event.                                                                                                                                                                                 |
| Notification     | string          | No       | Filter by notification template.                                                                                                                                                                      |
| Status           | select (string) | No       | Filter by one message status. Available values: Canceled, Clicked, Delayed, Delivered, Digested, Enqueued, Filtered, Opened, Routed, Sent, Simulated, Throttled, Undeliverable, Unmapped, Unroutable. |
| Tags             | string          | No       | Comma-separated metadata tags; any may match.                                                                                                                                                         |
| Include Archived | boolean         | No       | Whether archived messages should be included.                                                                                                                                                         |
| Cursor           | string          | No       | Resume from a prior next cursor.                                                                                                                                                                      |

**Outputs**

| Field       | Type          | Description                           |
| ----------- | ------------- | ------------------------------------- |
| Messages    | object\_array | Matching Courier message log entries. |
| Next Cursor | string        | Cursor for the next batch, if any.    |

#### Cancel Message

Cancel a delayed or queued Courier message before it is sent.

**Inputs**

| Field   | Type            | Required | Description                                                                                      |
| ------- | --------------- | -------- | ------------------------------------------------------------------------------------------------ |
| Message | select (string) | Yes      | Delayed or queued single-recipient message to cancel. Options load from the selected connection. |

**Outputs**

| Field      | Type   | Description                  |
| ---------- | ------ | ---------------------------- |
| Message ID | string | Canceled Courier message ID. |
| Status     | string | Updated message status.      |

#### Upsert Profile

Create a Courier user profile or merge fields into an existing profile.

**Inputs**

| Field             | Type     | Required | Description                              |
| ----------------- | -------- | -------- | ---------------------------------------- |
| User ID           | string   | Yes      | Stable application user ID.              |
| Email             | string   | No       | Email address to merge into the profile. |
| Phone Number      | string   | No       | E.164 phone number to merge.             |
| Name              | string   | No       | Recipient display name.                  |
| Locale            | string   | No       | Preferred content locale.                |
| Custom Attributes | textarea | No       | Custom profile attributes as JSON.       |

**Outputs**

| Field   | Type   | Description              |
| ------- | ------ | ------------------------ |
| User ID | string | Updated Courier user ID. |
| Status  | string | Courier update status.   |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/courier.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
