MepMail Audiences API

Resend's audience-scoped contact routes, kept for SDK compatibility.

GitHub OpenAPI

Operations 4

POST /audiences/{audienceId}/contacts Create a contact in an audience #
GET /audiences/{audienceId}/contacts/{id} Retrieve a contact in an audience #
PATCH /audiences/{audienceId}/contacts/{id} Update a contact in an audience #
DELETE /audiences/{audienceId}/contacts/{id} Delete a contact in an audience #

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-audiences-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-audiences-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mepmail Dev Audiences API
  version: 1.0.0
  description: 'Operations tagged Audiences 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: Audiences
  description: Resend's audience-scoped contact routes, kept for SDK compatibility.
paths:
  /audiences/{audienceId}/contacts:
    post:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: audienceId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContactRequest'
            example:
              email: customer@example.com
              first_name: Ana
              last_name: Silva
      responses:
        '200':
          description: Contact created in the audience
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactIdResponse'
              example:
                object: contact
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
        '401':
          description: Missing, malformed or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Plan limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Contact already exists
          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: createAudienceContact
      summary: Create a contact in an audience
      tags:
      - Audiences
      description: 'Resend-compatible route: creates a contact under an audience id.'
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
  /audiences/{audienceId}/contacts/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: audienceId
        in: path
      - schema:
          type: string
          minLength: 1
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Contact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContactResponse'
              example:
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
                email: customer@example.com
                first_name: Ana
                last_name: Silva
                created_at: '2026-10-19T12:00:00.000Z'
                unsubscribed: false
                object: contact
                properties: {}
        '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: getAudienceContact
      summary: Retrieve a contact in an audience
      tags:
      - Audiences
      description: 'Resend-compatible route: returns a contact under an audience id.'
    patch:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: audienceId
        in: path
      - schema:
          type: string
          minLength: 1
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactRequest'
            example:
              unsubscribed: true
      responses:
        '200':
          description: Contact updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactIdResponse'
              example:
                object: contact
                id: ae2014de-c168-4c61-8267-70d2662a1ce1
        '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: updateAudienceContact
      summary: Update a contact in an audience
      tags:
      - Audiences
      description: 'Resend-compatible route: updates a contact under an audience id.'
    delete:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: audienceId
        in: path
      - schema:
          type: string
          minLength: 1
        required: true
        name: id
        in: path
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
          description: MepMail extension. `true` also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window
        required: false
        description: MepMail extension. `true` also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window
        name: erase
        in: query
      responses:
        '200':
          description: Contact deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveContactResponse'
              example:
                object: contact
                contact: ae2014de-c168-4c61-8267-70d2662a1ce1
                deleted: true
        '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: deleteAudienceContact
      summary: Delete a contact in an audience
      tags:
      - Audiences
      description: 'Resend-compatible route: deletes a contact under an audience id.'
    servers:
    - url: https://api.mepmail.dev
      description: MepMail Cloud
    - url: '{baseUrl}'
      description: Self-hosted instance
      variables:
        baseUrl:
          default: http://localhost:3001
components:
  schemas:
    RemoveContactResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - contact
        contact:
          type: string
          format: uuid
        deleted:
          type: boolean
          enum:
          - true
      required:
      - object
      - contact
      - deleted
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
        name:
          type: string
        message:
          type: string
      required:
      - statusCode
      - name
      - message
    CreateContactRequest:
      type: object
      properties:
        email:
          type: string
          format: email
          description: Bare email address (no display name); unique per team
        first_name:
          type: string
          description: First name
        last_name:
          type: string
          description: Last name
        unsubscribed:
          type: boolean
          description: Global opt-out from all marketing sends
        properties:
          type: object
          additionalProperties: {}
          description: Flat map of custom properties (string or number values)
        segments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
            required:
            - id
          description: Segments to add the contact to on creation
        topics:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              subscription:
                type: string
                enum:
                - opt_in
                - opt_out
            required:
            - id
            - subscription
          description: Initial per-topic subscription choices
      required:
      - email
    GetContactResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
        first_name:
          type:
          - string
          - 'null'
        last_name:
          type:
          - string
          - 'null'
        created_at:
          type: string
        unsubscribed:
          type: boolean
        object:
          type: string
          enum:
          - contact
        properties:
          type: object
          additionalProperties:
            anyOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - string
                value:
                  type: string
              required:
              - type
              - value
            - type: object
              properties:
                type:
                  type: string
                  enum:
                  - number
                value:
                  type: number
              required:
              - type
              - value
      required:
      - id
      - email
      - first_name
      - last_name
      - created_at
      - unsubscribed
      - object
      - properties
    UpdateContactRequest:
      type: object
      properties:
        first_name:
          type:
          - string
          - 'null'
          description: First name; null clears it
        last_name:
          type:
          - string
          - 'null'
          description: Last name; null clears it
        unsubscribed:
          type: boolean
          description: Global opt-out from all marketing sends
        properties:
          type: object
          additionalProperties: {}
          description: Custom properties to set (merged); null removes a key
    ContactIdResponse:
      type: object
      properties:
        object:
          type: string
          enum:
          - contact
        id:
          type: string
          format: uuid
      required:
      - object
      - id
  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)