Mailchimp Messages API

openapi: 3.2.0
info:
  version: 1.4.1
  title: Mailchimp Transactional Messages API
  contact:
    name: API Support
    email: apihelp@mailchimp.com
  x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/transactional.openapi.json
servers:
- url: https://mandrillapp.com/api/1.3
tags:
- name: messages
paths:
  /messages/send-sms:
    post:
      x-custom-config:
        methodNameCamel: sendSms
        methodNameSnake: send_sms
      summary: Send SMS message
      description: Send a new SMS message through Mandrill
      operationId: postMessagesSendSms
      tags:
      - messages
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                description: SMS sending results
                items:
                  type: object
                  description: The sending results for a single SMS recipient
                  properties:
                    to:
                      type: string
                      description: the phone number of the recipient
                      example: '+10000000000'
                    from:
                      type: string
                      description: the phone number of the sender
                      example: '+10000000000'
                    status:
                      type: string
                      description: the sending status of the message
                      enum:
                      - sent
                      - queued
                      - scheduled
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queue_reason:
                      type: string
                      description: The reason for the queueing if the recipient status is queued
                      enum:
                      - multiple recipients
                      - async requested by user
                      example: multiple recipients
                    _id:
                      type: string
                      description: The message's unique id
                      example: abc123abc123abc123abc123abc123
            application/x-php:
              schema:
                type: array
                description: SMS sending results
                items:
                  type: object
                  description: The sending results for a single SMS recipient
                  properties:
                    to:
                      type: string
                      description: the phone number of the recipient
                      example: '+10000000000'
                    from:
                      type: string
                      description: the phone number of the sender
                      example: '+10000000000'
                    status:
                      type: string
                      description: the sending status of the message
                      enum:
                      - sent
                      - queued
                      - scheduled
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queue_reason:
                      type: string
                      description: The reason for the queueing if the recipient status is queued
                      enum:
                      - multiple recipients
                      - async requested by user
                      example: multiple recipients
                    _id:
                      type: string
                      description: The message's unique id
                      example: abc123abc123abc123abc123abc123
            application/x-yaml; charset=utf-8:
              schema:
                type: array
                description: SMS sending results
                items:
                  type: object
                  description: The sending results for a single SMS recipient
                  properties:
                    to:
                      type: string
                      description: the phone number of the recipient
                      example: '+10000000000'
                    from:
                      type: string
                      description: the phone number of the sender
                      example: '+10000000000'
                    status:
                      type: string
                      description: the sending status of the message
                      enum:
                      - sent
                      - queued
                      - scheduled
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queue_reason:
                      type: string
                      description: The reason for the queueing if the recipient status is queued
                      enum:
                      - multiple recipients
                      - async requested by user
                      example: multiple recipients
                    _id:
                      type: string
                      description: The message's unique id
                      example: abc123abc123abc123abc123abc123
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - message
              properties:
                key:
                  type: string
                  description: a valid api key
                message:
                  type: object
                  properties:
                    sms:
                      type: object
                      required:
                      - text
                      - to
                      - consent
                      - from
                      properties:
                        text:
                          type: string
                          description: the full SMS content to be sent
                        to:
                          type: array
                          description: the phone numbers to send the SMS message to
                          items:
                            type: string
                            description: a single recipient's phone number
                            example: '+10000000000'
                        from:
                          type: string
                          description: the phone number to send the SMS message from
                        consent:
                          type: string
                          description: The consent type for the message
                          enum:
                          - onetime
                          - recurring
                          - recurring-no-confirm
                        track_clicks:
                          type: boolean
                          description: whether or not to turn on click tracking for the message
                async:
                  type: boolean
                  description: enable a background sending mode that is optimized for bulk sending. In async mode, messages/send-sms will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
        required: true
  /messages/send:
    post:
      x-custom-config:
        methodNameCamel: send
        methodNameSnake: send
      summary: Send new message
      description: Send a new transactional message through the Transactional API.
      operationId: postMessagesSend
      tags:
      - messages
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                description: an array of objects for each recipient containing the key "email" with the email address, and details of the message status for that recipient
                items:
                  type: object
                  description: the sending results for a single recipient
                  properties:
                    email:
                      type: string
                      format: email
                      description: the email address of the recipient
                      example: user@example.com
                    status:
                      type: string
                      description: the sending status of the recipient
                      enum:
                      - sent
                      - queued
                      - scheduled
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queued_reason:
                      type: string
                      description: the reason for the email being queued if the response status is "queued"
                      enum:
                      - attachments
                      - multiple-recipients
                      - free-trial-sends-exhausted
                      - hourly-quota-exhausted
                      - monthly-limit-reached
                      - sending-paused
                      - sending-suspended
                      - account-suspended
                      - sending-backlogged
                      example: hourly-quota-exhausted
                    _id:
                      type: string
                      description: the message's unique id
                      example: a92c74e4c5d74998ba690cd535483bb7
            application/x-php:
              schema:
                type: array
                description: an array of objects for each recipient containing the key "email" with the email address, and details of the message status for that recipient
                items:
                  type: object
                  description: the sending results for a single recipient
                  properties:
                    email:
                      type: string
                      format: email
                      description: the email address of the recipient
                      example: user@example.com
                    status:
                      type: string
                      description: the sending status of the recipient
                      enum:
                      - sent
                      - queued
                      - scheduled
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queued_reason:
                      type: string
                      description: the reason for the email being queued if the response status is "queued"
                      enum:
                      - attachments
                      - multiple-recipients
                      - free-trial-sends-exhausted
                      - hourly-quota-exhausted
                      - monthly-limit-reached
                      - sending-paused
                      - sending-suspended
                      - account-suspended
                      - sending-backlogged
                      example: hourly-quota-exhausted
                    _id:
                      type: string
                      description: the message's unique id
                      example: a92c74e4c5d74998ba690cd535483bb7
            application/x-yaml; charset=utf-8:
              schema:
                type: array
                description: an array of objects for each recipient containing the key "email" with the email address, and details of the message status for that recipient
                items:
                  type: object
                  description: the sending results for a single recipient
                  properties:
                    email:
                      type: string
                      format: email
                      description: the email address of the recipient
                      example: user@example.com
                    status:
                      type: string
                      description: the sending status of the recipient
                      enum:
                      - sent
                      - queued
                      - scheduled
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queued_reason:
                      type: string
                      description: the reason for the email being queued if the response status is "queued"
                      enum:
                      - attachments
                      - multiple-recipients
                      - free-trial-sends-exhausted
                      - hourly-quota-exhausted
                      - monthly-limit-reached
                      - sending-paused
                      - sending-suspended
                      - account-suspended
                      - sending-backlogged
                      example: hourly-quota-exhausted
                    _id:
                      type: string
                      description: the message's unique id
                      example: a92c74e4c5d74998ba690cd535483bb7
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - message
              properties:
                key:
                  type: string
                  description: a valid api key
                message:
                  type: object
                  description: the information on the message to send
                  properties:
                    html:
                      type: string
                      description: the full HTML content to be sent
                    text:
                      type: string
                      description: optional full text content to be sent
                    subject:
                      type: string
                      description: the message subject
                    from_email:
                      type: string
                      description: the sender email address
                      format: email
                    from_name:
                      type: string
                      description: optional from name to be used
                    to:
                      type: array
                      description: an array of recipient information.
                      items:
                        type: object
                        description: a single recipient's information
                        required:
                        - email
                        properties:
                          email:
                            type: string
                            description: the email address of the recipient
                            format: email
                          name:
                            type: string
                            description: the optional display name to use for the recipient
                          type:
                            type: string
                            description: the header type to use for the recipient, defaults to "to" if not provided
                            enum:
                            - to
                            - cc
                            - bcc
                    headers:
                      type: object
                      description: optional extra headers to add to the message (most headers are allowed)
                    important:
                      type: boolean
                      description: whether or not this message is important, and should be delivered ahead of non-important messages
                    track_opens:
                      type: boolean
                      description: whether or not to turn on open tracking for the message
                    track_clicks:
                      type: boolean
                      description: whether or not to turn on click tracking for the message
                    auto_text:
                      type: boolean
                      description: whether or not to automatically generate a text part for messages that are not given text
                    auto_html:
                      type: boolean
                      description: whether or not to automatically generate an HTML part for messages that are not given HTML
                    inline_css:
                      type: boolean
                      description: whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size
                    url_strip_qs:
                      type: boolean
                      description: whether or not to strip the query string from URLs when aggregating tracked URL data
                    preserve_recipients:
                      type: boolean
                      description: whether or not to expose all recipients in to "To" header for each email
                    view_content_link:
                      type: boolean
                      description: set to false to remove content logging for sensitive emails
                    bcc_address:
                      type: string
                      description: an optional address to receive an exact copy of each recipient's email
                      format: email
                    tracking_domain:
                      type: string
                      description: a custom domain to use for tracking opens and clicks instead of mandrillapp.com
                    signing_domain:
                      type: string
                      description: a custom domain to use for SPF/DKIM signing instead of mandrill (for "via" or "on behalf of" in email clients)
                    return_path_domain:
                      type: string
                      description: a custom domain to use for the messages's return-path
                    merge:
                      type: boolean
                      description: whether to evaluate merge tags in the message. Will automatically be set to true if either merge_vars or global_merge_vars are provided.
                    merge_language:
                      type: string
                      description: the merge tag language to use when evaluating merge tags, either mailchimp or handlebars
                      enum:
                      - mailchimp
                      - handlebars
                    global_merge_vars:
                      type: array
                      description: global merge variables to use for all recipients. You can override these per recipient.
                      items:
                        type: object
                        description: a single global merge variable
                        properties:
                          name:
                            type: string
                            description: the global merge variable's name. Merge variable names are case-insensitive and may not start with _
                          content:
                            type: string
                            description: the global merge variable's content
                    merge_vars:
                      type: array
                      description: per-recipient merge variables, which override global merge variables with the same name.
                      items:
                        type: object
                        description: per-recipient merge variables
                        required:
                        - rcpt
                        properties:
                          rcpt:
                            type: string
                            description: the email address of the recipient that the merge variables should apply to
                            format: email
                          vars:
                            type: array
                            description: the recipient's merge variables
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: the merge variable's name. Merge variable names are case-insensitive and may not start with _
                                content:
                                  type: string
                                  description: the merge variable's content
                    tags:
                      type: array
                      description: an array of string to tag the message with. Stats are accumulated using tags, though we only store the first 100 we see, so this should not be unique or change frequently. Tags should be 50 characters or less. Any tags starting with an underscore are reserved for internal use and will cause errors.
                      items:
                        type: string
                        description: a single tag - must not start with an underscore
                    subaccount:
                      type: string
                      description: the unique id of a subaccount for this message - must already exist or will fail with an error
                    google_analytics_domains:
                      type: array
                      description: an array of strings indicating for which any matching URLs will automatically have Google Analytics parameters appended to their query string automatically.
                      items:
                        type: string
                    google_analytics_campaign:
                      type: string
                      description: optional string indicating the value to set for the utm_campaign tracking parameter. If this isn't provided the email's from address will be used instead.
                      format: email
                    metadata:
                      type: object
                      description: metadata an associative array of user metadata. Mandrill will store this metadata and make it available for retrieval. In addition, you can select up to 10 metadata fields to index and make searchable using the Mandrill search api.
                      properties:
                        website:
                          type: string
                          description: a valid website url
                    recipient_metadata:
                      type: array
                      description: Per-recipient metadata that will override the global values specified in the metadata parameter.
                      items:
                        type: object
                        description: metadata for a single recipient
                        properties:
                          rcpt:
                            type: string
                            description: the email address of the recipient that the metadata is associated with
                            format: email
                          values:
                            type: object
                            description: an associated array containing the recipient's unique metadata. If a key exists in both the per-recipient metadata and the global metadata, the per-recipient metadata will be used.
                            properties:
                              user_id:
                                type: integer
                                description: ''
                    attachments:
                      type: array
                      description: an array of supported attachments to add to the message
                      items:
                        type: object
                        description: a single supported attachment
                        properties:
                          type:
                            type: string
                            description: the MIME type of the attachment
                          name:
                            type: string
                            description: the file name of the attachment
                          content:
                            type: string
                            description: the content of the attachment as a base64-encoded string
                    images:
                      type: array
                      description: an array of embedded images to add to the message
                      items:
                        type: object
                        description: a single embedded image
                        properties:
                          type:
                            type: string
                            description: the MIME type of the image - must start with "image/"
                          name:
                            type: string
                            description: the Content ID of the image - use <img src="cid:THIS_VALUE"> to reference the image in your HTML content
                          content:
                            type: string
                            description: the content of the image as a base64-encoded string
                async:
                  type: boolean
                  description: enable a background sending mode that is optimized for bulk sending. In async mode, messages/send will immediately return a status of "queued" for every recipient. To handle rejections when sending in async mode, set up a webhook for the 'reject' event. Defaults to false for messages with no more than 10 recipients; messages with more than 10 recipients are always sent asynchronously, regardless of the value of async.
                ip_pool:
                  type: string
                  description: the name of the dedicated ip pool that should be used to send the message. If you do not have any dedicated IPs, this parameter has no effect. If you specify a pool that does not exist, your default pool will be used instead.
                send_at:
                  type: string
                  description: when this message should be sent as a UTC timestamp in YYYY-MM-DD HH:MM:SS format. If you specify a time in the past, the message will be sent immediately; for future dates, you're limited to one year from the date of scheduling.
                  format: date-time
        required: true
  /messages/send-template:
    post:
      x-custom-config:
        methodNameCamel: sendTemplate
        methodNameSnake: send_template
      summary: Send using message template
      description: Send a new transactional message through the Transactional API using a template.
      operationId: postMessagesSendTemplate
      tags:
      - messages
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                description: an array of objects for each recipient containing the key "email" with the email address, and details of the message status for that recipient
                items:
                  type: object
                  description: the sending results for a single recipient
                  properties:
                    email:
                      type: string
                      format: email
                      description: the email address of the recipient
                      example: user@example.com
                    status:
                      type: string
                      description: the sending status of the recipient
                      enum:
                      - sent
                      - queued
                      - rejected
                      - invalid
                      example: sent
                    reject_reason:
                      type: string
                      description: the reason for the rejection if the recipient status is "rejected"
                      enum:
                      - hard-bounce
                      - soft-bounce
                      - spam
                      - unsub
                      - custom
                      - invalid-sender
                      - invalid
                      - test-mode-limit
                      - unsigned
                      - rule
                      example: hard-bounce
                    queued_reason:
                      type: string
                      description: the reason for the email being queued if the response status is "queued"
                      enum:
                      - attachments
                      - multiple-recipients
                      - free-trial-sends-exhausted
                      - hourly-quota-exhausted
                      - monthly-limit-reached
                      - sending-paused
                      - sending-suspended
                      - account-suspended
                      - sending-backlogged
                      example: attachments
                    _id:
                      type: string
                      description: the 

# --- truncated at 32 KB (173 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-messages-api-openapi.yml