Courier

List all tenants in the workspace.

List all push/device tokens for a user.

List all tenants a user belongs to.

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

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

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

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

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 default; pass version (e.g. 'v001') to publish a specific historical version. Returns 204 on success.

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.

Publish a version of a tenant notification template.

Replace the elemental content of a journey-scoped notification template. Overwrites all elements. Call publish_journey_template afterwards to make it live.

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

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: "email", elements: [{ type: "meta", title: "Hello" }, { type: "text", content: "Email body" }] }, { type: "channel", channel: "push", elements: [{ type: "meta", title: "Hello" }, { type: "text", content: "Push body" }] }, { type: "channel", channel: "inbox", elements: [{ type: "text", content: "Inbox plain text only" }] }].

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", locale_id: "es", elements: [{ id: "elem_meta_1", title: "Restablecer contraseña" }, { id: "elem_text_1", content: "Haga clic en el enlace para restablecer su contraseña." }] }.

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.

Remove a user from all tenants.

Remove a user from a tenant.

Replace (update) a journey draft. Full document replacement — include all nodes and properties in the body. Call publish_journey afterwards to make changes live, or pass state: "PUBLISHED" to publish immediately. Send node template IDs must already be scoped to this journey.

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

Replace a notification template entirely (full document PUT).

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

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

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

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

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

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 unchanged. Rate limited per message (429 on rapid repeats).

Restore a previously deleted list.

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

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: "nt_01abc123", data: { name: "Alex", resetUrl: "https://app.example.com/reset" } }.

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.

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

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

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

Unsubscribe a user from a list.

Create or update an audience with a filter definition.

Replace an existing brand with new values.

Update check statuses for a notification submission.

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 if this integration is in use.

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 topic_id must already exist as a subscription topic in the workspace; a 404 means the topic has not been created yet. Example: { tenant_id: "acme", topic_id: "marketing-updates", status: "OPTED_IN", has_custom_routing: true, custom_routing: ["email", "push"] }.

Create or update a translation for a specific locale.

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