How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Courier Bulk API

The Bulk API from Courier — 4 operation(s) for bulk.

Courier Bulk API is one of 22 APIs that Courier publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bulk. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.courier.com.

5 operations 4 paths 47 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.courier.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Courier Bulk API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Bulk 5
POST
/bulk
Create a bulk job
bulk_createJob body → 200400
POST
/bulk/{job_id}
Add users
bulk_ingestUsers 1 param body → 204
GET
/bulk/{job_id}
Get a Job
bulk_getJob 1 param → 200400
POST
/bulk/{job_id}/run
Run a job
bulk_runJob 1 param → 204400
GET
/bulk/{job_id}/users
Get users
bulk_getUsers 2 params → 200400

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are UserRecipient (10 properties), ElementalTextNode (10 properties), ElementalActionNode (7 properties), InboundBulkMessage (7 properties). Each schema is shown below with its type and property counts.

ElementalNode
ElementalChannelNode
object
The channel element allows a notification to be customized based on which channel it is sent through. For example, you may want to display a detailed message w…
2 properties
ChannelPreference
object
1 property 1 required
BulkJobUserStatus
string
ChannelClassification
string
BulkJobStatus
string
UserRecipientType
object
ChannelSource
string
InboundBulkMessageUser
object
5 properties
BadRequest
object
1 property 1 required
ProfilePreferences
object
3 properties 1 required
NotificationPreferences
object
BulkCreateJobResponse
object
1 property 1 required
ElementalBaseNode
object
4 properties
Content
Preference
object
4 properties 1 required
ElementalContent
object
2 properties 2 required
ElementalTextNode
object
Represents a body of text to be rendered inside of the notification.
10 properties 2 required
ElementalHtmlNode
object
Raw HTML string inside an Elemental document. When rendering a message, this node is turned into output only for the email channel; for other channels it produ…
2 properties 1 required
BulkMessageUserResponse
object
2 properties 1 required
RecipientPreferences
object
2 properties
BulkGetJobUsersResponse
object
2 properties 2 required
ElementalImageNode
object
Used to embed an image into the notification.
5 properties 1 required
JobDetails
object
5 properties 5 required
BaseError
object
1 property 1 required
InboundBulkMessage
object
Bulk message definition. Supports two formats: - V1 format: Requires event field (event ID or notification ID) - V2 format: Optionally use template (notificati…
7 properties 1 required
MessageData
object
BulkIngestUsersParams
object
1 property 1 required
Paging
object
2 properties 1 required
TextAlign
string
MessageContext
object
1 property
ElementalMetaNode
object
The meta element contains information describing the notification that may be used by a particular channel or provider. One important field is the title field…
1 property
TextStyle
string
ElementalDividerNode
object
Renders a dividing line between elements.
1 property
IAlignment
string
ElementalContentSugar
object
Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
2 properties 2 required
Preferences
object
ElementalQuoteNode
object
Renders a quote block.
5 properties 3 required
NotificationPreferenceDetails
object
3 properties 1 required
Locale
object
1 property 1 required
ElementalActionNode
object
Allows the user to execute an action. Can be a button or a link.
7 properties 3 required
IActionButtonStyle
string
Locales
objectnull
UserRecipient
object
Send to a specific user by userid, email, phonenumber, or listid
10 properties
PreferenceStatus
string
BulkGetJobResponse
object
1 property 1 required
Rule
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

courier-bulk-api-openapi.yml Raw ↑

Other APIs Courier publishes across the network.

Courier Inbox Real-Time API
Courier Audiences API
Courier Audit Events API
Courier Authentication API
Courier Automations API
Courier Brands API
Courier Courier Create API
Courier Device Tokens API
Courier Inbound API
Courier Journeys API
Courier Lists API
Courier Notification Templates API
Where this information came from

This is an independent, third-party profile of Courier Bulk API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.