Deployments.ai Docs
Email

Send email and return the provider acceptance receipt

POST /v1/email/tenants/{tenantId}/messages · SDK sendEmail · CLI deployments email send

POST
/v1/email/tenants/{tenantId}/messages

Requires email:write.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

tenantId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string
Length1 <= length <= 512

Request Body

application/json
  1. body
from*string
to*array<string>
Items1 <= items <= 50
cc?array<string>
Itemsitems <= 50
bcc?array<string>
Itemsitems <= 50
replyTo?array<string>
Itemsitems <= 50
subject*string
Match^[^\p{Cc}\p{Cs}]*$
Lengthlength <= 998
text?string
html?string

Response Body

EmailSendResponse

application/json
  1. response
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
tenantId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
status*"accepted"
Value in"accepted"
providerMessageId*string
acceptedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
curl -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"}