Mailbox API

Send a mailbox message

Changed on

Creates and queues a message from the authenticated mailbox. Supply an Idempotency-Key header to safely retry. Attachments may use small inline base64 content or blob IDs returned by POST /mailbox/attachments:upload or POST /mailbox/attachment-uploads.

post/mailbox/messages/send

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages/send
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: email.send)

Query parameters

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Headers

Idempotency-Keystring

Client-chosen unique key to safely retry the request. Cached for 24h per (mailbox, endpoint, key). Different body with same key returns 409 idempotency_conflict.

Request body

custom_headersobject

Custom headers to include.

html_bodystring

HTML body.

subjectstring

Subject line; defaults to empty.

text_bodystring

Plain text body.

Example request

{
  "bcc": [
    {
      "email": "agent@example.com",
      "name": "Support"
    }
  ],
  "cc": [
    {
      "email": "agent@example.com",
      "name": "Support"
    }
  ],
  "from": {
    "email": "agent@example.com",
    "name": "Support"
  },
  "reply_to": [
    {
      "email": "agent@example.com",
      "name": "Support"
    }
  ],
  "to": [
    {
      "email": "agent@example.com",
      "name": "Support"
    }
  ]
}

Response

Message queued

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes

  • 901435205640Revision changes
    • warning

      the request property's maxLength was set to 998

    • info

      the request property became optional

    • info

      the request property became optional

  • 7807ce923952Revision changes
    • info

      the endpoint scheme security oauth2 was added to the API