Domains
Create Domain
CLI:
agentmail domains create --domain example.com
post/v0/domains
Request body
domainstring required
The name of the domain (e.g., example.com).
feedback_enabledboolean
Bounce and complaint notifications are sent to your inboxes.
subdomains_enabledboolean
Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.
Response
pod_idstring
ID of pod.
domain_idstring required
The ID of the domain.
domainstring required
The name of the domain (e.g., example.com).
status'NOT_STARTED' | 'PENDING' | 'INVALID' | 'FAILED' | 'VERIFYING' | 'VERIFIED' required
feedback_enabledboolean required
Bounce and complaint notifications are sent to your inboxes.
subdomains_enabledboolean required
Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.
client_idstring
Client ID of domain.
updated_atstring date-time required
Time at which the domain was last updated.
created_atstring date-time required
Time at which the domain was created.