Email
Register a sending domain ownership challenge
POST /v1/email/tenants/{tenantId}/domains · SDK createEmailDomain · CLI deployments email-domain create
POST
Requires email:admin.
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
domain*stringEmailDomainResponse
application/json- response
id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$projectId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$environmentId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$createdAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeupdatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timetenantId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$domain*stringstatus*stringValue in
"pending""provisioning""pending_dns""verified""failed""revoked"dnsRecords*array<>mailFromDomain*stringfailureReason?stringlastCheckedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeverifiedAt?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/domains" \ -H "x-deployments-environment: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "domain": "string" }'{ "id": "string", "organizationId": "string", "projectId": "string", "environmentId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "tenantId": "string", "domain": "string", "status": "pending", "dnsRecords": [ { "name": "string", "type": "CNAME", "value": "string", "priority": 0 } ], "mailFromDomain": "string", "failureReason": "string", "lastCheckedAt": "2019-08-24T14:15:22Z", "verifiedAt": "2019-08-24T14:15:22Z"}