contact@agentmail.ccDiscord
DocumentationAPI ReferenceChangelog
DocumentationAPI ReferenceChangelog
  • API Reference
Logo
contact@agentmail.ccDiscord
API ReferencePodsDomains

Create Domain

POST
/v0/pods/:pod_id/domains
POST
/v0/pods/:pod_id/domains
1from agentmail import AgentMail
2
3client = AgentMail(
4    base_url="https://api.agentmail.to",
5    api_key="YOUR_TOKEN_HERE"
6)
7
8client.pods.domains.create(
9    pod_id="pod_id",
10    domain="domain",
11    feedback_enabled=True
12)
Try it
200Successful
1{
2  "domain_id": "domain_id",
3  "status": "PENDING",
4  "feedback_enabled": true,
5  "records": [
6    {
7      "type": "TXT",
8      "name": "name",
9      "value": "value",
10      "status": "MISSING",
11      "priority": 1
12    },
13    {
14      "type": "TXT",
15      "name": "name",
16      "value": "value",
17      "status": "MISSING",
18      "priority": 1
19    }
20  ],
21  "updated_at": "2024-01-15T09:30:00Z",
22  "created_at": "2024-01-15T09:30:00Z",
23  "client_id": "client_id"
24}
Was this page helpful?
Previous

Delete Domain

Next
Built with
Delete Domain

Authentication

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

Path Parameters

pod_idstringRequired
ID of pod.

Request

This endpoint expects an object.
domainstringRequired

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

feedback_enabledbooleanRequired
Whether bounce and complaint notifications are sent to your inboxes.

Response

This endpoint returns an object.
domain_idstring

The name of the domain. (e.g., ” your-domain.com”)

statusenum
The verification status of the domain.
Allowed values:
feedback_enabledboolean
Whether bounce and complaint notifications are sent to your inboxes.
recordslist of objects
A list of DNS records required to verify the domain.
updated_atdatetime
Time at which the domain was last updated.
created_atdatetime
Time at which the domain was created.
client_idstring or null
Client ID of domain.

Errors

ID of pod.

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