Courier

Courier Messages API

Inspect, track, cancel, and archive sent messages.

GitHub OpenAPI

Documentation

📖
APIReference
https://www.courier.com/docs/reference/send/send-a-message
📖
Documentation
https://www.courier.com/docs/sending/index
📖
APIReference
https://www.courier.com/docs/reference/messages
📖
APIReference
https://www.courier.com/docs/reference/lists
📖
APIReference
https://www.courier.com/docs/reference/profiles
📖
APIReference
https://www.courier.com/docs/reference/user-preferences
📖
APIReference
https://www.courier.com/docs/reference/token-management
📖
APIReference
https://www.courier.com/docs/reference/notifications
📖
APIReference
https://www.courier.com/docs/reference/brands
📖
APIReference
https://www.courier.com/docs/reference/automations
📖
APIReference
https://www.courier.com/docs/reference/audiences
📖
APIReference
https://www.courier.com/docs/reference/tenants
📖
APIReference
https://www.courier.com/docs/reference/bulk
📖
APIReference
https://www.courier.com/docs/reference/audit-events
📖
APIReference
https://www.courier.com/docs/reference/translations

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/courier-com/refs/heads/main/openapi/courier-com-messages-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/courier-com/refs/heads/main/collections/courier-com.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/courier-com/refs/heads/main/collections/courier-com.opencollection.json

OpenAPI Specification

courier-com-messages-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Courier Audiences Messages 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: Messages
  description: Inspect, track, cancel, and archive sent messages.
paths:
  /messages:
    get:
      operationId: listMessages
      tags:
      - Messages
      summary: List messages
      description: Fetch the statuses of messages you have previously sent.
      parameters:
      - name: cursor
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
      - name: recipient
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A paged list of messages.
          content:
            application/json:
              schema:
                type: object
                properties:
                  paging:
                    $ref: '#/components/schemas/Paging'
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Message'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /messages/{message_id}:
    parameters:
    - $ref: '#/components/parameters/MessageId'
    get:
      operationId: getMessage
      tags:
      - Messages
      summary: Get a message
      description: Retrieve the status of a single message by id.
      responses:
        '200':
          description: The requested message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /messages/{message_id}/content:
    parameters:
    - $ref: '#/components/parameters/MessageId'
    get:
      operationId: getMessageContent
      tags:
      - Messages
      summary: Get message content
      description: Retrieve the rendered content of a message as delivered to each channel.
      responses:
        '200':
          description: The rendered message content.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /messages/{message_id}/history:
    parameters:
    - $ref: '#/components/parameters/MessageId'
    get:
      operationId: getMessageHistory
      tags:
      - Messages
      summary: Get message history
      description: Retrieve the delivery and engagement history for a message (ENQUEUED, SENT, DELIVERED, OPENED, CLICKED, UNDELIVERABLE, etc.).
      responses:
        '200':
          description: The message history events.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /messages/{message_id}/cancel:
    parameters:
    - $ref: '#/components/parameters/MessageId'
    post:
      operationId: cancelMessage
      tags:
      - Messages
      summary: Cancel a message
      description: Cancel a message that is currently enqueued and not yet delivered.
      responses:
        '200':
          description: The cancelled message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /messages/{message_id}/archive:
    parameters:
    - $ref: '#/components/parameters/MessageId'
    put:
      operationId: archiveMessage
      tags:
      - Messages
      summary: Archive a message
      description: Archive a message so it no longer appears in the default message list.
      responses:
        '204':
          description: The message was archived.
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
    Paging:
      type: object
      properties:
        cursor:
          type: string
        more:
          type: boolean
    Message:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
          - ENQUEUED
          - SENT
          - DELIVERED
          - OPENED
          - CLICKED
          - UNMAPPED
          - UNROUTABLE
          - UNDELIVERABLE
          - CANCELED
        enqueued:
          type: integer
        sent:
          type: integer
        delivered:
          type: integer
        opened:
          type: integer
        clicked:
          type: integer
        recipient:
          type: string
        notification:
          type: object
          additionalProperties: true
  parameters:
    MessageId:
      name: message_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 Messages 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.