Create Domain
Request Body
string
required
The domain name. Must be a valid domain format.Example:
"yourdomain.com"Valid formats:domain.comsubdomain.domain.commail.company.co.uk
Response
string
Unique identifier for the domain.
string
ID of the organization that owns this domain.
string
The domain name.
boolean
Whether the domain has been verified. Will be
false initially.array
Array of DNS record verification status objects.
string
ISO 8601 timestamp of when the domain was created.
string
ISO 8601 timestamp of when the domain was last updated.
Error Responses
400 Bad Request"Invalid domain name format"- The domain name format is invalid
List Domains
Response
Returns an array of domain objects.string
Unique identifier for the domain.
string
ID of the organization that owns this domain.
string
The domain name.
boolean
Whether the domain has been verified.
array
Array of DNS record verification status objects.
string
ISO 8601 timestamp of when the domain was created.
string
ISO 8601 timestamp of when the domain was last updated.
Get Domain
Path Parameters
string
required
The domain name (used as the identifier).Example:
"yourdomain.com"Response
string
Unique identifier for the domain.
string
ID of the organization that owns this domain.
string
The domain name.
boolean
Whether the domain has been verified.
array
Array of DNS record verification status objects.
string
ISO 8601 timestamp of when the domain was created.
string
ISO 8601 timestamp of when the domain was last updated.
Error Responses
404 Not Found"Domain not found"- The domain doesn’t exist or doesn’t belong to your organization
Get DNS Records
Path Parameters
string
required
The domain name.Example:
"yourdomain.com"Response
Returns an array of DNS record objects that must be added to your domain.string
The DNS record type.Values:
MX, TXT, CNAMEstring
The DNS record name/host.
@represents the root domain- For subdomains, this will be the subdomain prefix
- For DKIM records, this will be a specific token subdomain
string
The DNS record value/target.
number
Priority value for MX records.Only present for MX records.
DNS Records Explained
MX Record
MX Record
Purpose: Routes incoming emails to AWS SESConfiguration:
- Type:
MX - Name:
@(or subdomain prefix) - Value:
inbound-smtp.us-east-2.amazonaws.com - Priority:
10
SPF Record
SPF Record
Purpose: Prevents email spoofing by authorizing AWS SES to send emails from your domainConfiguration:
- Type:
TXT - Name:
@(or subdomain prefix) - Value:
v=spf1 include:amazonses.com ~all
DMARC Record
DMARC Record
Purpose: Defines how receiving servers should handle emails that fail authenticationConfiguration:
- Type:
TXT - Name:
_dmarc(or_dmarc.subdomain) - Value:
v=DMARC1; p=reject;
DKIM Records
DKIM Records
Purpose: Digital signature verification to prove emails are authentic and unmodifiedConfiguration:
- Type:
CNAME - Name:
[token]._domainkey.yourdomain.com - Value:
[token].dkim.amazonses.com
Error Responses
400 Bad Request"Failed to get DKIM attributes"- Unable to retrieve DKIM tokens from AWS SES
"Domain not found"- The domain doesn’t exist or doesn’t belong to your organization
Verify Domain
DNS changes can take up to 48 hours to propagate. If verification fails, wait and try again later.
Path Parameters
string
required
The domain name to verify.Example:
"yourdomain.com"Response
Returns the updated domain object with verification status.string
Unique identifier for the domain.
string
ID of the organization that owns this domain.
string
The domain name.
boolean
Whether the domain has been successfully verified.Will be
true if verification succeeded, false otherwise.array
Array of DNS record verification status objects showing which records passed or failed verification.
string
ISO 8601 timestamp of when the domain was created.
string
ISO 8601 timestamp of when the domain was last updated.
Error Responses
404 Not Found"Domain not found"- The domain doesn’t exist or doesn’t belong to your organization
Delete Domain
Path Parameters
string
required
The domain name to delete.Example:
"yourdomain.com"Response
Returns the deleted domain object.string
Unique identifier for the deleted domain.
string
ID of the organization that owned this domain.
string
The domain name.
boolean
Whether the domain was verified before deletion.
array
Array of DNS record verification status objects.
string
ISO 8601 timestamp of when the domain was created.
string
ISO 8601 timestamp of when the domain was last updated.
Error Responses
404 Not Found"Domain not found"- The domain doesn’t exist or doesn’t belong to your organization