Mailbox API

Upload a mailbox attachment

Changed on

Uploads one attachment as binary data and returns a blob ID that can be supplied to POST /mailbox/messages/send.

post/mailbox/attachments:upload

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/attachments:upload
  • 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)
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read, mailbox.drafts.write)

Query parameters

filenamestring required

Filename to use when sending the uploaded attachment.

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.

Response

Attachment uploaded

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "content_type": "application/pdf",
    "filename": "invoice.pdf",
    "size_bytes": 12345
  }
}

Changes