Courier

Add users to an existing bulk job.

Append subscribers to a list without removing existing subscribers.

Add a user to a tenant.

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

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

Archive a notification template by ID.

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

Archive a topic within a section.

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

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

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

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

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 override not included is reset to its topic default. An empty `topics` array clears all overrides. Validation-atomic (all-or-nothing).

Replace all subscribers on a list with the given recipients.

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-success: valid topics are written and returned in `items`, unapplicable ones collected in `errors`.

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 started. Note: spelling is "cancelation_token" (single "l").

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 was already canceled is left unchanged.

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

Cancel a notification template submission.

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.

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 secondary). Example: { name: "Acme", settings: { colors: { primary: "#1a73e8", secondary: "#ffffff" } } }.

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

Create a new journey. Defaults to DRAFT state. Send nodes are not allowed on create — create the shell with a trigger node, then call replace_journey to add send nodes after linking notification templates. Call publish_journey to make it live. Node ids are server-generated; do NOT include an id field. Example: { name: "Welcome Journey", nodes: [{ type: "trigger", trigger_type: "api-invoke" }], enabled: true }.

Create a notification template scoped to a journey. Defaults to DRAFT; pass state: "PUBLISHED" to publish on create. The template can then be referenced in journey send nodes. Example: { journey_id: "j-abc", channel: "email", notification: { name: "Welcome Email", tags: [], brand: null, subscription: null, content: { version: "2022-01-01", elements: [{ type: "text", content: "Hello!" }] } } }.

Create or update a list by list ID.

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 publish_notification (or pass state: 'PUBLISHED' on create). Link a routing strategy via notification.routing.strategy_id to control which channels are used. Example: { notification: { name: 'welcome-email', tags: [], brand: null, subscription: null, routing: { strategy_id: 'rs_01abc' }, content: { version: '2022-01-01', elements: [] } } }.

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

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

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

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

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

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 and settings against list_provider_catalog before saving. The provider field must be a known Courier provider key.

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

Delete an audience by its ID.

Delete a brand by its ID.

Delete a list by its ID.

Delete a user profile permanently.

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

Delete a tenant by its ID.

Remove default notification preference for a topic from a tenant.

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

Delete all list subscriptions for a user.

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

Delete a specific push token for a user.

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

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

Get a specific audit event by its ID.

Get a brand by its ID.

Get the status of a bulk job.

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