Courier

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.).

List notification templates. Optionally filter by cursor.

Get the published content blocks of a notification template.

List configured provider integrations for the workspace.

Fetch a single provider configuration by ID.

Retrieve a routing strategy by ID. Returns the full entity including routing, channels, and providers.

List the workspace's preference sections. Each section embeds its topics.

Create a new journey. Always created as a draft; making it live is a separate step this tool cannot perform. Send two nodes: the trigger, and an exit node last. Both are required — a create with no ex…

Get a journey by ID. Pass version=draft to retrieve the working draft, or version=vN for a historical version. Defaults to published.

Replace (update) a journey draft. Full document replacement — include all nodes and properties in the body, the trigger included; anything omitted is deleted. The journey stays a draft; making the cha…

Create a notification template scoped to a journey. Always created as a draft; making it live is a separate step this tool cannot perform. The template can then be referenced in journey send nodes. Ex…

Replace the elemental content of a journey-scoped notification template. Overwrites all elements. The template stays a draft; making it live is a separate step this tool cannot perform.

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. Call list_automations first to get the template_id. Example: { template_id: "auto-onboarding", recipient: "user-123", data: { plan: "pro"…

Invoke an ad-hoc automation with inline steps. Valid step actions: send, send-list, delay, cancel, update-profile, invoke, fetch-data. To cancel a previously started automation, use the cancel_automat…

List automation templates in the workspace. Always call this first to discover template_id values before calling invoke_automation_template. Optionally filter by version.

Cancel a running automation by its cancelation_token. This invokes a second ad-hoc automation with a single cancel step. The token must match the cancelation_token set when the original automation was…

Create a new brand. The API requires settings — omitting it returns a 400. If you do not have specific brand colors, omit settings and a safe default will be used automatically (black primary, white s…

Get a brand by its ID.

List all brands in the workspace.

Replace an existing brand with new values.

Delete a brand by its ID.

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.

Delete a list by its ID.

Restore a previously deleted list.

Replace all subscribers on a list with the given recipients.

Append subscribers to a list without removing existing subscribers.

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

Resend a previously sent message. Loads the original send request and enqueues a brand-new send to the same recipient with the same content, producing a new messageId; the original message is unchange…

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

Create a V2 notification template. name is required. Provide content inline or set it immediately after creation via put_notification_content. To send with this template you must publish it first via …

Retrieve a notification template by ID. Optionally request draft, published, or a version such as v001.

Replace a notification template entirely (full document PUT).

Archive a notification template by ID.

List version history for a notification template.

Publish a notification template, making it available for sending. Must be called before send_message_template unless the template was created with state: 'PUBLISHED'. Publishes the current draft by de…

List checks for a notification submission.

Update check statuses for a notification submission.

Replace the elemental content of a V2 notification template. Overwrites all elements. Use channel elements to target specific channels. Multi-channel example: elements: [{ type: "channel", channel: "e…

Update a single element within a V2 notification template.

Set locale-specific content overrides for a V2 notification template. Each element override must reference an existing element by its id. Example for Spanish locale: { notification_id: "nt_01abc", loc…

Cancel a notification template submission.

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.

Partially update a user profile via JSON Patch (RFC 6902). Use add/replace/remove operations on specific profile paths.

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 published notification template. The template must be published before sending — call publish_notification first if needed. Example: { user_id: "user-123", template: "…

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.

List users associated with a tenant.

Set the default notification preference for a subscription topic on a tenant. This controls tenant-level defaults — it does NOT set per-user preferences (use the user preferences API for that). The to…

Remove default notification preference for a topic from a tenant.

List notification templates configured for a tenant.

Get a tenant notification template association by template ID.

Create or replace a tenant notification template (draft unless published is true).

Publish a version of a tenant notification template.

Get a specific version of a tenant notification template (e.g. latest, published, or v1).

Delete a tenant notification template. Returns 204 on success, 404 if the template does not exist for this tenant.

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.

Add multiple push/device tokens for a user in one request. Overwrites matching existing tokens.

Apply a JSON Patch (RFC 6902) to a specific push token.

Delete a specific push token for a user.

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

Get a user's preference for a specific subscription topic.

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

Delete a user's preference for a specific subscription topic, reverting it to the topic's default status.

List all tenants a user belongs to.

Add a user to a tenant.

Remove a user from a tenant.

Add a user to multiple tenants at once. A custom profile can be supplied per tenant.

Remove a user from all tenants.

Additively create or update a user's preferences for one or more topics in a single request. Only the topics in the body are touched; existing overrides for other topics are left untouched. Partial-su…

Replace a user's complete set of preference overrides in one request. The topics in the body become the recipient's entire override set: listed topics are created or updated, and every existing overri…

Archive a send request and all its associated messages by request ID.

Create a routing strategy defining how notifications are delivered across channels and providers.

Replace a routing strategy. Full document replacement; missing optional fields are cleared.

Archive a routing strategy. The strategy must not have associated notification templates; unlink all templates before archiving.

List routing strategies in the workspace. Returns metadata only; use get for full details.

List notification templates associated with a routing strategy. Useful for checking linked templates before archiving.

List journey templates in the workspace. Call this first to discover journey IDs before calling invoke_journey, get_journey, or replace_journey. Optionally filter by version (published or draft).

Invoke a journey run from a journey template. Call list_journeys first to find the template_id. Example: { template_id: "j-onboarding", user_id: "user-123", data: { plan: "pro" } }.

Publish the current draft of a journey, making it live and invokable. Pass version to roll back to a prior published version instead of publishing the draft. Returns 404 if there is no draft to publis…

Archive a journey. Archived journeys cannot be invoked but existing runs continue to completion.

List published versions of a journey, ordered most recent first.

List notification templates scoped to a journey. Journey-scoped templates can only be used by send nodes within the same journey. Call this to discover template IDs before wiring send nodes in replace…

Get a journey-scoped notification template by notification ID. Pass version=draft to retrieve the working draft (required before the template has been published). Defaults to published.

Replace the draft of a journey-scoped notification template. Full document replacement. Call publish_journey_template afterwards to make it live.

Archive a journey-scoped notification template. Archived templates cannot be sent.

Publish the current draft of a journey-scoped notification template. Optionally pass version to roll back to a prior version.

List published versions of a journey-scoped notification template, ordered most recent first.

Fetch the elemental content of a journey-scoped notification template. Pass version=draft for the working draft, or vN for a historical version. Defaults to published.

Set locale-specific content overrides for a journey-scoped notification template. Each element override must reference an existing element by its id.

Cancel journey runs. Supply EXACTLY ONE of cancelation_token (cancels every run associated with the token) or run_id (cancels a single run). Cancelation is idempotent: a run that already finished or w…

List available provider types from the catalog with their configuration schemas.

Create a new provider (integration) configuration. Once routing strategies or notification templates reference this config, credential or settings mistakes can affect live sends—confirm provider key a…

Replace an existing provider configuration. Full replacement — retrieve current config with get_provider first; omitted optional fields are cleared. Changing API keys or settings affects live delivery…

Delete a provider configuration. Returns 409 if the provider is still referenced by routing or notifications.

Create a preference section in your workspace. The section id is generated and returned. Add topics afterwards with create_preference_topic.

Retrieve a preference section by id, including its topics.

Replace a preference section. Full document replacement; missing optional fields are cleared. Topics attached to the section are unaffected.

Archive a preference section. The section must be empty: delete its topics first, otherwise the request fails with 409.

Publish the workspace's preferences page. Takes a snapshot of every section with its topics under a new published version, making the current state visible on the hosted preferences page.

List the topics in a preference section.

Create a subscription preference topic inside a section. The topic id is generated and returned. Fails with 404 if the section does not exist.

Retrieve a topic within a section. Returns 404 if the section or topic does not exist, or the topic belongs to a different section.

Replace a topic within a section. Full document replacement; missing optional fields are cleared.

Archive a topic within a section.

Release a digest schedule early — send what users have collected so far now instead of waiting for the scheduled time. A 204 is also returned when the schedule has no in-progress instances to release.

List the digest instances for a schedule. Each instance represents the events accumulated for a single user against the schedule, useful for monitoring accumulation before a digest is released.