Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Upload Attachment

Request, response and authentication details for your Mailat instance.

← All API operations
POST/api/v1/compose/attachments

UploadAttachment uploads an attachment POST /api/v1/compose/attachments

Authentication & compatibility

Use a scoped bearer API key with email:send. The key is bound to its user and organization.

Primary SES compose workflow. Reply/forward contexts use public SES mailbox UUIDs; draft and attachment operations use owned records. In legacy non-SES configurations, sending can fall back to JMAP.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request POST "$MAILAT_BASE_URL/api/v1/compose/attachments" \
  --header "Authorization: Bearer $MAILAT_TOKEN" \
  --form 'file=@/path/to/file' # Add the required fields listed below

Build the request from the schema below; request.json and upload paths are local placeholders.

Request body (required)

multipart/form-data

bodyobjectrequired
Fields
filestring (binary)required
identityIdintegerrequired

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success
Header: X-RateLimit-Remaininginteger

Remaining requests in this API key's current minute window (present for API-key authentication).

minimum: 0

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · service.AttachmentRef
blobIdstring
cidstring

Content-ID for inline

contentstring

Base64 for a newly attached file

dispositionstring

attachment or inline

namestring
sizeinteger (int64)
typestring
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract