API ReferenceDomains

Create Domain

**CLI:** ```bash agentmail domains create --domain example.com ```

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
domainstringRequired

The name of the domain (e.g., example.com).

feedback_enabledbooleanOptional
Bounce and complaint notifications are sent to your inboxes.
subdomains_enabledbooleanOptional

Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.

tracking_enabledbooleanOptional

Serve open tracking pixels from this domain. Adds a required link.<domain> CNAME record to records, which must be published and verified before track_opens can be used on a send.

Response

This endpoint returns an object.
domain_idstring
The ID of the domain.
domainstring

The name of the domain (e.g., example.com).

statusenum
The verification status of the domain.
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.

tracking_enabledboolean

Serve open tracking pixels from this domain. Adds a required link.<domain> CNAME record to records, which must be published and verified before track_opens can be used on a send.

recordslist of objects

A list of DNS records required to verify the domain. Includes a wildcard MX record (*.<domain>) when subdomains_enabled is true.

updated_atdatetime
Time at which the domain was last updated.
created_atdatetime
Time at which the domain was created.
pod_idstringOptional
ID of pod.
client_idstringOptional
Client ID of domain.

Errors

400
Validation Error