Courier

Courier Bulk API

One-to-many sends via jobs.

Documentation GitHub OpenAPI

OpenAPI Specification

openapi: 3.0.3
info:
  title: Courier Audiences Bulk API
  description: 'Courier is notification infrastructure that orchestrates transactional and product messaging across email, SMS, push, chat, and an in-app inbox from a single REST API. This document models the primary public endpoints under the base URL https://api.courier.com: sending notifications (Send), inspecting sent messages, managing lists, user profiles, preferences, device tokens, notification templates, brands, automations, audiences, tenants, bulk jobs, audit events, and translations. All requests are authenticated with a Bearer API key. Endpoint paths are grounded in Courier''s published API reference; request and response bodies are modeled and simplified.'
  version: 2024-01
  contact:
    name: Courier
    url: https://www.courier.com
  x-endpoint-confidence: Paths and methods are grounded in the Courier API reference (https://www.courier.com/docs/reference). Schemas are modeled, not exhaustive.
servers:
- url: https://api.courier.com
  description: Courier production API
security:
- bearerAuth: []
tags:
- name: Bulk
  description: One-to-many sends via jobs.
paths:
  /bulk:
    post:
      operationId: createBulkJob
      tags:
      - Bulk
      summary: Create a bulk job
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  $ref: '#/components/schemas/InboundBulkMessage'
      responses:
        '200':
          description: The created bulk job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  jobId:
                    type: string
  /bulk/{job_id}:
    parameters:
    - $ref: '#/components/parameters/JobId'
    get:
      operationId: getBulkJob
      tags:
      - Bulk
      summary: Get a bulk job
      responses:
        '200':
          description: The bulk job status.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
    post:
      operationId: addUsersToBulkJob
      tags:
      - Bulk
      summary: Add users to a bulk job
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                users:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
      responses:
        '204':
          description: The users were added.
  /bulk/{job_id}/run:
    parameters:
    - $ref: '#/components/parameters/JobId'
    post:
      operationId: runBulkJob
      tags:
      - Bulk
      summary: Run a bulk job
      responses:
        '202':
          description: The bulk job started running.
  /bulk/{job_id}/users:
    parameters:
    - $ref: '#/components/parameters/JobId'
    get:
      operationId: listBulkJobUsers
      tags:
      - Bulk
      summary: List users in a bulk job
      responses:
        '200':
          description: The users in the bulk job.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
components:
  schemas:
    InboundBulkMessage:
      type: object
      properties:
        template:
          type: string
        brand:
          type: string
        data:
          type: object
          additionalProperties: true
        event:
          type: string
        locale:
          type: object
          additionalProperties: true
  parameters:
    JobId:
      name: job_id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Courier API key passed as `Authorization: Bearer <YOUR_API_KEY>`. Keys are found in the Courier settings under API Keys and are environment scoped (test vs production).'

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.

Courier Bulk API

Documentation

Specifications

Other Resources

OpenAPI Specification