MepMail Broadcasts API

One email to a whole segment.

GitHub OpenAPI

Operations 7

POST /broadcasts Create a broadcast #
GET /broadcasts List broadcasts #
GET /broadcasts/{id} Retrieve a broadcast #
PATCH /broadcasts/{id} Update a broadcast #
DELETE /broadcasts/{id} Delete a broadcast #
POST /broadcasts/{id}/send Send a broadcast #
POST /broadcasts/{id}/cancel Cancel a broadcast #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mepmail-dev:mepmail-dev-broadcasts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mepmail-dev-broadcasts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mepmail Dev Broadcasts API
  version: 1.0.0
  description: 'Operations tagged Broadcasts across 2 of this provider''s published API definitions: docs.json, mepmail-dev-docs-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.mepmail.dev
  description: MepMail Cloud
- url: '{baseUrl}'
  description: Self-hosted instance
  variables:
    baseUrl:
      default: http://localhost:3001
security:
- apiKey: []
tags:
- name: Broadcasts
  description: One email to a whole segment.
paths:
  /broadcasts:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBroadcastRequest'
            example:
              name: October newsletter
              segment_id: 8c1d4e2f-0a3b-4c5d-9e6f-7a8b9c0d1e2f
              topic_id: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
              from: Acme <news@yourdomain.com>
              subject: What is new in October
              html: <p>Here is what changed this month.</p>
              send: false
      responses:
        '200':
          description: 'Broadcast created (and scheduled when send: true)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendBroadcastResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                finishes_at: '2026-10-19T12:00:00.000Z'
                estimated: true
                warning:
                  code: paced
                  days: 1
                  message: A human-readable explanation
        '400':
          description: Broadcast state conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Restricted API key or sending paused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: createBroadcast
      summary: Create a broadcast
      tags:
      - Broadcasts
      description: Creates a broadcast to a segment, and schedules it when send is true.
    get:
      parameters:
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          description: Page size, 1-100 (default 20)
        required: false
        description: Page size, 1-100 (default 20)
        name: limit
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        required: false
        description: 'Cursor: id of the last item of the previous page. Must be an id this list returned; there is no sentinel value.'
        name: after
        in: query
      - schema:
          type: string
          format: uuid
          description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        required: false
        description: 'Cursor: id of the first item of the next page (page backwards); same rule as after.'
        name: before
        in: query
      responses:
        '200':
          description: Broadcasts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBroadcastsResponse'
              example:
                object: list
                data:
                - id: 4ef9a417-02e9-4d39-ad75-9611e0fcc33c
                  name: Order updates
                  segment_id: 4ef9a417-02e9-4d39-ad75-9611e0fcc33c
                  status: status
                  created_at: '2026-10-19T12:00:00.000Z'
                  scheduled_at: '2026-10-19T12:00:00.000Z'
                  sent_at: '2026-10-19T12:00:00.000Z'
                  sent_count: 1
                  finishes_at: '2026-10-19T12:00:00.000Z'
                has_more: false
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: listBroadcasts
      summary: List broadcasts
      tags:
      - Broadcasts
      description: Lists the team's broadcasts.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /broadcasts/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Broadcast
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBroadcastResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                name: Order updates
                segment_id: ae2014de-c168-4c61-8267-70d2662a1ce1
                status: status
                created_at: '2026-10-19T12:00:00.000Z'
                scheduled_at: '2026-10-19T12:00:00.000Z'
                sent_at: '2026-10-19T12:00:00.000Z'
                sent_count: 1
                finishes_at: '2026-10-19T12:00:00.000Z'
                object: broadcast
                from: Acme <hello@yourdomain.com>
                subject: Your order has shipped
                reply_to:
                - support@yourdomain.com
                preview_text: Your order is on its way
                topic_id: ae2014de-c168-4c61-8267-70d2662a1ce1
                html: <p>Your order is on its way.</p>
                text: Your order is on its way.
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getBroadcast
      summary: Retrieve a broadcast
      tags:
      - Broadcasts
      description: Returns one broadcast with its status and counts.
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBroadcastRequest'
            example:
              subject: What is new this October
      responses:
        '200':
          description: Broadcast updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BroadcastIdResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
        '400':
          description: Not a draft
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: updateBroadcast
      summary: Update a broadcast
      tags:
      - Broadcasts
      description: Changes a draft broadcast before it is sent.
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Broadcast deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveBroadcastResponse'
              example:
                object: broadcast
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                deleted: true
        '400':
          description: Not a draft
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: deleteBroadcast
      summary: Delete a broadcast
      tags:
      - Broadcasts
      description: Deletes a draft broadcast.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /broadcasts/{id}/send:
    post:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendBroadcastRequest'
            example:
              scheduled_at: in 1 hour
      responses:
        '200':
          description: Broadcast scheduled; finishes_at and warning say when it goes out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendBroadcastResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                finishes_at: '2026-10-19T12:00:00.000Z'
                estimated: true
                warning:
                  code: paced
                  days: 1
                  message: A human-readable explanation
        '400':
          description: Not a draft
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Sending paused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: sendBroadcast
      summary: Send a broadcast
      tags:
      - Broadcasts
      description: Schedules a broadcast now or at a later time.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /broadcasts/{id}/cancel:
    post:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Broadcast canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelBroadcastResponse'
              example:
                object: broadcast
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                canceled_remaining: 1
        '400':
          description: Not queued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: 'Rate limit exceeded: 600 requests per minute per API key and 3,000 per team; wait for Retry-After'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: cancelBroadcast
      summary: Cancel a broadcast
      tags:
      - Broadcasts
      description: Cancels a scheduled broadcast before it goes out.
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
components:
  schemas:
    CancelBroadcastResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - broadcast
        id:
          type: string
          format: uuid
        canceled_remaining:
          type: integer
          description: Emails stopped before going out; the ones already sent are not recalled
      required:
      - object
      - id
      - canceled_remaining
    SendBroadcastResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        finishes_at:
          type:
          - string
          - 'null'
          description: When the last email is expected to go out (ISO 8601); null when unknown
        estimated:
          type: boolean
          enum:
          - true
          description: finishes_at is an estimate that moves as other sends come in
        warning:
          type: object
          properties:
            code:
              type: string
              enum:
              - paced
              - queued_behind
              description: 'paced: more than the capacity available now; queued_behind: other sends go first'
            days:
              type: integer
              description: Days the send spans
            message:
              type: string
          required:
          - code
          - days
          - message
      required:
      - id
    GetBroadcastResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        segment_id:
          type:
          - string
          - 'null'
          format: uuid
        status:
          type: string
        created_at:
          type: string
        scheduled_at:
          type:
          - string
          - 'null'
        sent_at:
          type:
          - string
          - 'null'
        sent_count:
          type:
          - integer
          - 'null'
          description: Emails handed off so far; null before the send starts and once its emails have left the retention window
        finishes_at:
          type:
          - string
          - 'null'
          description: Estimated instant the last email goes out, while the broadcast is going out; else null
        object:
          type: string
          enum:
          - broadcast
        from:
          type: string
        subject:
          type: string
        reply_to:
          type:
          - array
          - 'null'
          items:
            type: string
        preview_text:
          type:
          - string
          - 'null'
        topic_id:
          type:
          - string
          - 'null'
          format: uuid
        html:
          type:
          - string
          - 'null'
        text:
          type:
          - string
          - 'null'
      required:
      - id
      - name
      - segment_id
      - status
      - created_at
      - scheduled_at
      - sent_at
      - sent_count
      - finishes_at
      - object
      - from
      - subject
      - reply_to
      - preview_text
      - topic_id
      - html
      - text
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
        name:
          type: string
        message:
          type: string
      required:
      - statusCode
      - name
      - message
    RemoveBroadcastResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - broadcast
        id:
          type: string
          format: uuid
        deleted:
          type: boolean
          enum:
          - true
      required:
      - object
      - id
      - deleted
    ListBroadcastsResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - list
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type:
                - string
                - 'null'
              segment_id:
                type:
                - string
                - 'null'
                format: uuid
              status:
                type: string
              created_at:
                type: string
              scheduled_at:
                type:
                - string
                - 'null'
              sent_at:
                type:
                - string
                - 'null'
              sent_count:
                type:
                - integer
                - 'null'
                description: Emails handed off so far; null before the send starts and once its emails have left the retention window
              finishes_at:
                type:
                - string
                - 'null'
                description: Estimated instant the last email goes out, while the broadcast is going out; else null
            required:
            - id
            - name
            - segment_id
            - status
            - created_at
            - scheduled_at
            - sent_at
            - sent_count
            - finishes_at
        has_more:
          type: boolean
      required:
      - object
      - data
      - has_more
    CreateBroadcastRequest:
      type: object
      properties:
        name:
          type: string
          description: Internal name shown in the dashboard
        segment_id:
          type: string
          format: uuid
          description: Segment to send to; omitted means every contact of the team
        from:
          type: string
          description: Sender, "Name <user@domain>"; the domain must be verified for the team
        subject:
          type: string
          minLength: 1
          description: Subject line; supports {{{FIRST_NAME|there}}} merge fields
        html:
          type: string
          description: HTML body; include {{{UNSUBSCRIBE_URL}}} for the opt-out link
        text:
          type: string
          description: Plain-text body; at least one of html/text is required
        reply_to:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
            minItems: 1
            maxItems: 50
          description: Reply-To address or list
        preview_text:
          type: string
          description: Inbox preview (preheader) text
        topic_id:
          type:
          - string
          - 'null'
          format: uuid
          description: Topic id; only contacts subscribed to it receive the broadcast
        send:
          type: boolean
          description: true sends (or schedules) immediately instead of saving a draft
        scheduled_at:
          type: string
          description: 'Deliver later (requires send: true): ISO 8601 with offset or relative like "in 1 hour"'
      required:
      - from
      - subject
    UpdateBroadcastRequest:
      type: object
      properties:
        name:
          type: string
        segment_id:
          type: string
          format: uuid
        from:
          type: string
        subject:
          type: string
          minLength: 1
        html:
          type: string
        text:
          type: string
        reply_to:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
            minItems: 1
            maxItems: 50
        preview_text:
          type: string
        topic_id:
          type:
          - string
          - 'null'
          format: uuid
    BroadcastIdResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
      required:
      - id
    SendBroadcastRequest:
      type: object
      properties:
        scheduled_at:
          type: string
          description: 'Deliver later: ISO 8601 with offset or relative like "in 1 hour"; omitted sends now'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key from the dashboard (ms_…), sent as Authorization: Bearer. A sending-only key reaches the /emails routes only.'
x-refined-from:
- docs.json
- mepmail-dev-docs-openapi.json
x-provenance:
  method: harvested
  publisher: MepMail
  source: https://docs.mepmail.dev/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)