Send Email
Request, response and authentication details for your Mailat instance.
/api/v1/compose/sendSendEmail sends a new email POST /api/v1/compose/send
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 POST "$MAILAT_BASE_URL/api/v1/compose/send" \
--header "Authorization: Bearer $MAILAT_TOKEN" \
--header "Idempotency-Key: replace-with-a-stable-job-key" \
--header 'Content-Type: application/json' \
--data '{
"identityId": 1,
"inReplyTo": "<[email protected]>",
"references": [
"<[email protected]>"
],
"subject": "Re: Hello",
"textBody": "Thank you",
"to": [
{
"email": "[email protected]"
}
]
}'Parameters
Idempotency-KeystringrequiredPersist one key per logical submission. Reuse it with the identical request on retries; changed content returns 409. Single-email sends accept either this header or JSON idempotencyKey; both must agree when supplied together. Batch and compose require this header.
minLength: 8 · maxLength: 128
Request body (required)
application/json
bodyobjectrequiredAt least one recipient across to/cc/bcc; SES accepts at most 50 combined. The rendered subject is limited to 1000 bytes and combined text/HTML body to 2 MiB. Limits are bytes, not Unicode character counts.
Fields · model.ComposeEmailRequest
attachmentsarraymaxItems: 50
Each itemobjectFields · model.AttachmentDTO
blobIdstringcidstringcontentstringdispositionstringnamestringsizeinteger (int64)typestringbccarrayEach itemobjectFields · model.EmailAddressDTO
emailstring (email)requirednamestringccarrayEach itemobjectFields · model.EmailAddressDTO
emailstring (email)requirednamestringdraftIdstringdraftVersioninteger (int64)fromEmailstringhtmlBodystringidentityIdinteger (int64)requiredinReplyTostringreferencesarrayEach itemstringreplyToarrayEach itemobjectFields · model.EmailAddressDTO
emailstring (email)requirednamestringsubjectstringrequiredtextBodystringtoarrayEach itemobjectFields · model.EmailAddressDTO
emailstring (email)requirednamestringVariant 1objectFields
toarrayrequiredminItems: 1
Variant 2objectFields
ccarrayrequiredminItems: 1
Variant 3objectFields
bccarrayrequiredminItems: 1
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-RemainingintegerRemaining requests in this API key's current minute window (present for API-key authentication).
minimum: 0
application/json
responseobjectFields
codeintegerrequireddataall of · nullableVariant 1objectFields · service.SendEmailResult
emailIdstringmessageIdstringsendErrorstringsentAtstring (date-time)statusstringthreadIdstringmessagestringrequired400 · Invalid input
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired401 · Missing, expired or revoked authentication
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired403 · Insufficient permission
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired404 · Resource not found
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired409 · Conflict or changed idempotency payload
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired410 · Recovery cursor expired; resynchronize
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired429 · Rate limit exceeded; respect Retry-After
Header: Retry-AfterintegerSeconds until the next fixed-minute request window.
minimum: 1
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired500 · Internal failure; retain the idempotency key
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired