Courier API

Name: Courier API
Brand: Courier API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsPush Notificationsbearer63 EndpointsREST

For Agents

Send transactional notifications across email, SMS, push, and chat through one call, plus manage user profiles, device tokens, bulk jobs, audiences, brands, and automations.

Install Jentic One Beta

Connect the Courier API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Courier API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Courier API.

Send a notification to a user across email, SMS, push, and chat with one POST /send call

Run bulk notification jobs that fan out a single template to thousands of recipients

Manage user profiles, preferences, and device tokens to drive routing per recipient

GET STARTED

Start building with Courier API

Explore with Jentic

View OpenAPI Document

Use for: Send a transactional notification to a user across the channels they prefer, Send the same notification to a list of 5,000 users in a bulk job, Update a user profile with a new email and phone number, Add a device token for push notifications to a user

Not supported: Does not handle marketing campaign editors, A/B testing UIs, or raw provider-specific features such as Twilio sub-accounts — use for orchestrating multi-channel transactional notifications, profiles, and automations only.

Jentic publishes the only available OpenAPI specification for Courier API, keeping it validated and agent-ready. Courier is a notification orchestration platform that routes a single send call across email, SMS, push, and chat channels based on per-user preferences and provider availability. The API exposes endpoints to send messages, manage user profiles and device tokens, run bulk jobs, build audiences, configure tenants and brands, manage automations, store notification templates, and inspect logs. It removes the need to integrate SendGrid, Twilio, OneSignal, and Slack separately for transactional notifications.

Use Cases

Patterns agents use Courier API for, with concrete tasks.

★ Multi-Channel Transactional Notifications

Replace direct integrations with SendGrid, Twilio, and OneSignal by routing all transactional messages through Courier. The agent calls POST /send with a recipient, template ID, and data payload; Courier picks the channel based on the user's preferences and falls back to the next channel if delivery fails. This collapses several vendor SDKs into a single uniform API call.

Call POST /send with message.to.user_id, message.template, and message.data, and let Courier route across email, SMS, and push.

Bulk Lifecycle Campaigns

Send the same lifecycle message — onboarding, renewal reminder, win-back — to a defined cohort of users through a Courier bulk job. The agent creates a job via POST /bulk, adds users in batches via POST /bulk/{jobId}, then calls POST /bulk/{jobId}/run to execute. Status and per-user results are queryable via GET /bulk/{jobId} and GET /bulk/{jobId}/users.

Call POST /bulk with template='onboarding-day-3', POST /bulk/{jobId} with the user batch, then POST /bulk/{jobId}/run.

User Preference and Device Token Management

Maintain accurate notification routing by syncing user profiles and device tokens whenever users change their settings. The agent calls PATCH /profiles/{userId} when a user updates their email or phone, GET /users/{userId}/tokens to inspect their devices, and POST /profiles/{userId} to merge in new preference data. Courier uses these fields to decide which channel to send on.

Call PATCH /profiles/{userId} with the new email and phone whenever a user updates their settings.

Automations and Onboarding Flows

Trigger multi-step Courier automations when key user events occur (signup, first-purchase, churn risk). The agent invokes a saved automation by ID with a payload containing the user and event data, and Courier orchestrates a sequence of sends with conditional branches and delays. This replaces hand-coded retry loops and per-step send logic.

Call the automations invoke endpoint with the saved automation ID and a payload containing user_id and event='signup'.

Agent-Driven Notifications via Jentic

Connect Courier to an AI agent through Jentic so a workflow can say 'send Priya the order-shipped notification' as one tool call. The agent searches Jentic for the right Courier operation, loads the schema, and calls POST /send with the bearer token kept in the Jentic vault. The token never enters the agent's prompt or response.

Use the Jentic Python SDK to search for 'send a transactional notification', load POST /send, and execute it with the recipient and template.

Key Endpoints

63 endpoints — jentic publishes the only available openapi specification for courier api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/send

Send a multi-channel notification

POST

/bulk

Create a bulk notification job

POST

/bulk/{jobId}

Add users to a bulk job

POST

/bulk/{jobId}/run

Execute a bulk job

GET

/profiles/{userId}

Retrieve a user profile

PATCH

/profiles/{userId}

Update a user profile

GET

/users/{userId}/tokens

List a user's device tokens

POST

/send

Send a multi-channel notification

POST

/bulk

Create a bulk notification job

POST

/bulk/{jobId}

Add users to a bulk job

POST

/bulk/{jobId}/run

Execute a bulk job

GET

/profiles/{userId}

Retrieve a user profile

PATCH

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Courier bearer API key is stored encrypted in the Jentic vault and injected into the Authorization header at execution time. Agents receive scoped tokens, so the raw key never appears in prompts, model context, or logs.

Intent-based discovery

Agents search Jentic by intent (e.g. 'send a transactional notification' or 'create a bulk job') and Jentic returns the matching Courier operation with its message schema, so the agent can call the right endpoint without reading courier.com/docs.

Time to first call

Direct Courier integration: 1-2 days to wire the message-shape schema, bulk job lifecycle, and webhook delivery callbacks. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using Courier API through Jentic.

Why is there no official OpenAPI spec for Courier API?

Courier publishes HTML reference docs at courier.com/docs but does not export a single downloadable OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Courier API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Courier API use?

The API uses HTTP bearer authentication. You issue an API key from the Courier dashboard and pass it in the Authorization header as 'Bearer {key}'. Through Jentic, the key is stored encrypted in the vault and only scoped tokens reach the agent's context.

Can I send the same notification to many users at once with the Courier API?

Yes. Create a bulk job via POST /bulk, add user batches with POST /bulk/{jobId}, then call POST /bulk/{jobId}/run to dispatch the job. Inspect status with GET /bulk/{jobId} and per-user delivery results with GET /bulk/{jobId}/users.

What are the rate limits for the Courier API?

Courier applies per-workspace request limits that depend on your plan (typically a few hundred sends per second on production tiers). High-volume sends should use the bulk endpoints rather than looping POST /send. Through Jentic, watch 429 responses and back off.

How do I send a transactional notification through Jentic?

Search Jentic for 'send a notification' and the POST /send Courier operation is returned with its message-shape schema. Load the operation, then execute it with message.to.user_id, message.template, and message.data. The standard quickstart is pip install jentic, search, load, execute.

Is the Courier API free?

Courier offers a free tier with a monthly send quota suitable for development; paid plans raise the quota and unlock features like bulk jobs and brand management. There is no separate per-call API charge beyond the message-volume tier.

Courier API

Connect the Courier API to your agent

Capabilities

Start building with Courier API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs