Agent Email
Register a custom email domain
POST /v1/agent-email/domains · SDK createAgentEmailDomain · CLI deployments inbox-domain create
POST
Requires agent-email:admin.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
domain*stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
1 <= length <= 253placementId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$AgentEmailDomainResponse
application/json- response
createdAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timednsRecords*array<>domain*stringfailureReason?stringid*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$lastCheckedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timemailFromDomain*stringorganizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$placementId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$providerIdentity?stringproviderManaged*booleanproviderMetadata*status*stringValue in
"failed""pending""pending_dns""provisioning""revoked""verified"updatedAt*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/agent-email/domains" \ -H "x-deployments-environment: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "domain": "string" }'{ "createdAt": "2019-08-24T14:15:22Z", "dnsRecords": [ { "name": "string", "priority": 0, "type": "CNAME", "value": "string" } ], "domain": "string", "failureReason": "string", "id": "string", "lastCheckedAt": "2019-08-24T14:15:22Z", "mailFromDomain": "string", "organizationId": "string", "placementId": "string", "providerIdentity": "string", "providerManaged": true, "providerMetadata": { "property1": null, "property2": null }, "status": "failed", "updatedAt": "2019-08-24T14:15:22Z", "verifiedAt": "2019-08-24T14:15:22Z"}