Email
Send email and return the provider acceptance receipt
POST /v1/email/tenants/{tenantId}/messages · SDK sendEmail · CLI deployments email send
POST
Requires email:write.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
tenantId*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
from*stringto*array<string>Items
1 <= items <= 50cc?array<string>Items
items <= 50bcc?array<string>Items
items <= 50replyTo?array<string>Items
items <= 50subject*stringMatch
^[^\p{Cc}\p{Cs}]*$Length
length <= 998text?stringhtml?stringEmailSendResponse
application/json- response
id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$tenantId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$status*"accepted"Value in
"accepted"providerMessageId*stringacceptedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecurl -X POST "https://example.com/v1/email/tenants/string/messages" \ -H "x-deployments-environment: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "from": "string", "to": [ "string" ], "subject": "string" }'{ "id": "string", "tenantId": "string", "status": "accepted", "providerMessageId": "string", "acceptedAt": "2019-08-24T14:15:22Z"}