Mailboxes
Messages

Stage a message attachment

Upload raw attachment bytes for later use by send or scheduled-message update. The returned ID is bound to this API key, organization, and mailbox, and expires after 24 hours.

post/mailboxes/{id}/staged-attachments

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/staged-attachments
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

filenamestring required

Headers

Idempotency-Keystring

Unique key for idempotent requests. Printable ASCII, 1-255 characters. The response is cached for 24 hours. A message send also derives the message ID from the key, so after the cache expires a retry on the same endpoint returns the message already sent, without comparing the body, for as long as that message exists.

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Attachment staged.

object'staged_attachment' required
idstring required
mailbox_idstring required
filenamestring required
content_typestring required
sizeinteger required
sha256string required
expires_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.