PodsDomains

Create Domain

CLI:

agentmail pods:domains create --pod-id <pod_id> --domain example.com

post/v0/pods/{pod_id}/domains

Path parameters

pod_idstring required

ID of pod.

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).

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.

Changes

Changed in 4 of the 34 revisions of this API.4622

Jul 15, 2026394ddcdd9c298See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became optional
  request-property-became-optional
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
Mar 31, 202627965096e61817See the full diff
- ▲
  the response's property type changed from string to no type for status
  response-property-type-changed
- ○
  removed the FAILED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the NOT_STARTED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PENDING enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the VERIFIED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the VERIFYING enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 28, 20268a5b5e92ae2d26See the full diff
- ▲
  the response's property type changed from no type to string for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  added the new FAILED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new INVALID enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new NOT_STARTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PENDING enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new VERIFIED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new VERIFYING enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 19, 20267fdcd6b4651f17See the full diff
- ▲
  the response's property type changed from string to no type for status
  response-property-type-changed
- ○
  removed the FAILED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the INVALID enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the NOT_STARTED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PENDING enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the VERIFIED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the VERIFYING enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  added the required property to the response with the status
  response-required-property-added

Full history