Skip to main content

Courier home page

Request demo
Login
Sign Up
Sign Up

Getting Started

Introduction
Authentication
Idempotent Requests
Rate Limiting

Send

Introduction
POST
Send a message

Audiences

Introduction
Audience Operators
Usage
GET
Get an audience
PUT
Update an audience
DEL
Delete an audience
GET
List audience members
GET
List all audiences

Audit Events

Introduction
GET
Get all audit events
GET
Get an audit event

AuthTokens

Introduction
POST
Create an auth token

Automations

Introduction
POST
Invoke an Automation
POST
Invoke Ad Hoc Automation

Brands

Introduction
POST
Create a new brand
GET
Get a brand
GET
List brands
DEL
Delete a brand
PUT
Replace a brand

Bulk

Introduction
POST
Create a bulk job
POST
Add users
POST
Run a job
GET
Get a Job
GET
Get users

Courier Create

GET
Get a Template in Tenant
GET
List Templates in Tenant

Inbound

POST
Courier Track Event

Lists

Introduction
GET
Get all lists
GET
Get a list
PUT
Update a list
DEL
Delete a list
PUT
Restore a list
GET
Get the subscriptions for a list
PUT
Subscribe users to a list
POST
Add subscribers to a list
PUT
Subscribe a single user to a list
DEL
Unsubscribe a user from a list

Messages

Introduction
GET
List messages
GET
Get message
POST
Cancel message
GET
Get message history
GET
Get message content
PUT
Archive message

Notification Templates

Notifications
GET
Get notifications
POST
Courier Track Event
GET
Get notifications content
GET
Get notifications draftcontent
GET
Get notifications checks
PUT
Put notifications checks
DEL
Delete notifications checks

Tenants

Introduction
PUT
Create or Replace a Tenant
GET
Get a Tenant
GET
Get a List of Tenants
DEL
Delete a Tenant
GET
Get Users in Tenant
PUT
Create Tenant Preferences
DEL
Remove Tenant Preferences

Translations

Introduction
GET
Get a translation
PUT
Update translations by locale

User Preferences

Introduction
GET
Get user's preferences
GET
Get user subscription topic
PUT
Update or Create user preferences for a specific subscription topic

User Profiles

Introduction
GET
Get a profile
POST
Create a profile
PATCH
Update a profile
PUT
Replace a profile
DEL
Delete a profile
GET
Get list subscriptions
POST
Subscribe to one or more lists
DEL
Delete list subscriptions

User Tenants

GET
Get tenants associated with a given user
PUT
Add a User to Multiple Tenants
DEL
Remove User From All Associated Tenants
PUT
Add a User to a Single Tenant
DEL
Remove User from a Tenant

User Tokens

Introduction
GET
Get single token
GET
Get all tokens
PUT
Add single token to user
PUT
Add multiple tokens to user
PATCH
Update a token
DEL
Delete User Token

Brands

Brands API

The Brands API enables programmatic creation and management of branded email templates with custom themes, instantly updating all notifications using the brand.

Invoke Ad Hoc Automation Create a new brand

⌘I

github linkedin x