Skip to main content
POST

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body

string
required
A valid domain name to add (e.g. example.com or mail.example.com). Must not include a protocol (http://), a path, or a trailing slash. Maximum 253 characters.
string
The AutoSend region key where your email service will be configured for this domain (e.g. us-east-1, ap-south-1, us-east-2, eu-central-1). If omitted, the project’s primary region is used.

Response

boolean
Indicates whether the request was successful.
object
The newly created domain object. The initial verificationStatus is always PENDING_CONFIGURATION. Configure the required DNS records in your DNS provider and then call POST /domains/{domainId}/verify to start verification.

Errors

object
Returned when the domain field is missing, empty, exceeds 253 characters, or is not a valid domain name (e.g. includes a protocol or path).
object
Returned when the domain has already been added to this project.