Use the send API to send a message to one or more recipients.

Send a message

Get an audience

A unique identifier representing the audience id

Update an audience

Delete an audience

A unique identifier that allows for fetching the next set of members

List audience members

Get the audiences associated with the authorization token.

A unique identifier that allows for fetching the next set of audiences

List all audiences

Audiences

A unique identifier that allows for fetching the next set of audit events.

Get all audit events

A unique identifier associated with the audit event you wish to retrieve

Get an audit event

Audit Events

Create an auth token

Auth Tokens

Invoke an automation run from an automation template.

A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias.

Invoke an Automation

Invoke Ad Hoc Automation

Automations

Create a new brand

A unique identifier associated with the brand you wish to retrieve.

Get a brand

A unique identifier that allows for fetching the next set of brands.

List brands

Delete a brand

Replace an existing brand with the supplied values.

A unique identifier associated with the brand you wish to update.

Replace a brand

Brands

Create a bulk job

A unique identifier representing the bulk job

Add users

Run a job

Get a Job

Get users

Bulk

Add opt-in to default preferences for a tenant

New Order Placed

Courier Track Event

Inbound

Returns all of the lists, with the ability to filter based on a pattern.

A unique identifier that allows for fetching the next page of lists.

Get all lists

Returns a list based on the list ID provided.

A unique identifier representing the list you wish to retrieve.

Get a list

Create or replace an existing list with the supplied values.

Update a list

Delete a list

Restore a list

A unique identifier that allows for fetching the next set of list subscriptions

Get the subscriptions for a list

Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.

Subscribe users to a list

Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.

Add subscribers to a list

Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).

A unique identifier representing the recipient associated with the list

Subscribe a single user to a list

Delete a subscription to a list by list ID and user ID.

Unsubscribe a user from a list

Lists

Fetch the statuses of messages you've previously sent.

A boolean value that indicates whether archived messages should be included in the response.

A unique identifier that allows for fetching the next set of messages.

A unique identifier representing the event that was used to send the event.

A unique identifier representing the list the message was sent to.

A unique identifier representing the notification that was used to send the event.

The key assocated to the provider you want to filter on. E.g., sendgrid, inbox, twilio, slack, msteams, etc. Allows multiple values to be set in query parameters.

A unique identifier representing the recipient associated with the requested profile.

An indicator of the current status of the message. Allows multiple values to be set in query parameters.

A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters.

A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.

Messages sent with the context of a Tenant

The enqueued datetime of a message to filter out messages received before.

The unique identifier used to trace the requests

List messages

Fetch the status of a message you've previously sent.

A unique identifier associated with the message you wish to retrieve (results from a send).

Get message

A unique identifier representing the message ID

Cancel message

Fetch the array of events of a message you've previously sent.

A supported Message History type that will filter the events returned.

Get message history

Get message content

A unique identifier representing the request ID

Archive message

Messages

Retrieve the notes from the Notification template settings.

List

Get Content

Get Draft Content

Get Submission Checks

Replace Submission Checks

Cancel Submission

Notifications

A unique identifier representing the user associated with the requested profile.

Get a profile

Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.

Create a profile

Replace a profile

Delete a profile

Returns the subscribed lists for a specified user.

A unique identifier that allows for fetching the next set of message statuses.

Get list subscriptions

Subscribes the given user to one or more lists. If the list does not exist, it will be created.

Subscribe to one or more lists

Removes all list subscriptions for given user.

Delete list subscriptions

Profiles

A unique identifier that allows for fetching the next set of templates

List templates

Templates

A unique identifier representing the tenant to be returned.

Create or Replace a Tenant

Get a Tenant

The number of tenants to return
(defaults to 20, maximum value of 100)

Continue the pagination with the next cursor

Get a List of Tenants

Delete a Tenant

The number of accounts to return
(defaults to 20, maximum value of 100)

Get Users in Tenant

Id of the tenant to update the default preferences for.

Id fo the susbcription topic you want to have a default preference for.

Create or Replace Default Preferences For Topic

Remove Default Preferences For Topic

Tenants

The locale you want to retrieve the translations for

Get a translation

Update translations by locale

Translations

Get user's preferences

Fetch user preferences for a specific subscription topic.

Get user subscription topic

Update or Create user preferences for a specific subscription topic.

Update or Create user preferences for a specific subscription topic

Preferences

This endpoint is used to add a user to
multiple tenants in one call.
A custom profile can also be supplied for each tenant.
This profile will be merged with the user's main
profile when sending to the user with that tenant.

Add a User to Multiple Tenants

Add a User to a Single Tenant

Removes a user from any tenants they may have been associated with.

Remove User From All Associated Tenants

Remove User from a Tenant

Returns a paginated list of user tenant associations.

Get tenants associated with a given user

Adds multiple tokens to a user and overwrites matching existing tokens.

Add multiple tokens to user

Adds a single token to a user and overwrites a matching existing token.

Add single token to user

Apply a JSON Patch (RFC 6902) to the specified token.

Update a token

Get single token

Get all tokens

Delete User Token

Tokens

Users

SendMessageResponse

Audience

AudienceListResponse

AudienceMember

AudienceMemberGetResponse

AudienceMemberListResponse

AudienceUpdateResponse

BaseFilterConfig

ComparisonOperator

Filter

FilterConfig

LogicalOperator

NestedFilterConfig

Operator

SingleFilterConfig

The attribe name from profile whose value will be operated against the filter value

Actor

AuditEvent

GetAuditEventParams

ListAuditEventsParams

ListAuditEventsResponse

Target

IssueTokenResponse

AccessorType

Automation

AutomationAdHocInvokeParams

AutomationAddToBatchMaxItemsType

Defines what items should be retained and passed along to the next steps when the batch is released

AutomationAddToBatchRetain

The number of records to keep in batch. Default is 10 and only configurable by requesting from support.
When configurable minimum is 2 and maximum is 100.

1	curl -X PUT https://api.courier.com/profiles/:user_id \
2	-H "Authorization: Bearer <authorizationToken>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"profile": {
6	"string": {}
7	}
8	}'

Replace a profile

Path parameters

Request

Response