Courier

Get an audience by its ID, including its filter definition.

List all members of an audience.

List all audiences in the workspace.

Create or update an audience with a filter definition.

Delete an audience by its ID.

Get a specific audit event by its ID.

List audit events in the workspace. Useful for tracking API usage and changes.

Generate a JWT authentication token for a user. Used for client-side SDK auth (Inbox, Preferences, etc.).

Invoke an automation run from an existing automation template.

Invoke an ad-hoc automation with inline steps (no template needed).

Create a new brand with name, colors, and email/inapp settings.

Get a brand by its ID.

List all brands in the workspace.

Create a new bulk job for sending messages to multiple recipients. Workflow: create_bulk_job → add_bulk_users → run_bulk_job.

Add users to an existing bulk job.

Run a bulk job, triggering delivery to all added users.

Get the status of a bulk job.

List the users in a bulk job.

Get the Courier SDK installation guide for a specific platform. For client-side SDKs (React, iOS, Android, Flutter, React Native), also generates a sample JWT.

Track an inbound event that can trigger automations. Requires event name, messageId (for deduplication), and properties.

Get all lists. Optionally filter by pattern (e.g. 'example.list.*').

Get a list by its ID.

Get all subscribers of a list.

Create or update a list by list ID.

Subscribe a user to a list. Creates the list if it doesn't exist.

Unsubscribe a user from a list.

List messages you've previously sent. Filter by status, recipient, notification, provider, tags, or tenant.

Get the full details and status of a single message by its ID.

Get the rendered content (HTML, text, subject) of a previously sent message.

Get the event history for a message, showing each step in the delivery pipeline (enqueued, sent, delivered, etc.).

Cancel a message that is currently being delivered. Returns the message details with updated status.

List notification templates. Optionally filter by cursor.

Get the published content blocks of a notification template.

Get the draft (unpublished) content blocks of a notification template.

Get a user profile by their ID. Returns profile data including email, phone, and custom properties.

Create a new user profile or merge supplied values into an existing profile (POST). Existing fields not included are preserved.

Fully replace a user profile (PUT). All existing data is overwritten; include every field you want to keep.

Delete a user profile permanently.

Get all list subscriptions for a user.

Subscribe a user to one or more lists. Creates lists that do not exist.

Delete all list subscriptions for a user.

Send a message to a user using inline title and body content (no template). Optionally specify routing channels.

Send a message to a user using a pre-configured notification template. Optionally pass data and routing.

Send a message to all subscribers of a list using inline title and body content.

Send a message to all subscribers of a list using a notification template.

Get a tenant by its ID.

Create or replace a tenant. Tenants represent organizations or groups that users belong to.

List all tenants in the workspace.

Delete a tenant by its ID.

Get a translation for a specific locale (e.g. "en_US", "fr_FR").

Create or update a translation for a specific locale.

List all push/device tokens for a user.

Get a specific push/device token for a user.

Create or replace a push/device token for a user.

Get a user's notification preferences (subscriptions, opt-outs, channel preferences).

Update a user's preference for a specific subscription topic (opt in, opt out, or set channel preferences).

List all tenants a user belongs to.

Add a user to a tenant.

Remove a user from a tenant.