Skip to main content
POST
/
bulk
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const response = await client.bulk.createJob({ message: { event: 'event' } });

console.log(response.jobId);
{
  "jobId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
message
InboundBulkMessage · object
required

Bulk message definition. Supports two formats:

  • V1 format: Requires event field (event ID or notification ID)
  • V2 format: Optionally use template (notification ID) or content (Elemental content) in addition to event

Response

​
jobId
string
required