Skip to main content

​
Domain statuses

​
AddDomain

Adds a custom domain to your account. Returns the domain record with a verification token. DNS records are configured asynchronously — check the required records using ListDomains or VerifyDomain after a moment. Inputs
​
string
required
The domain name to add (e.g., "example.com"). Must be a valid domain format, not a public email provider domain, and not already registered on AgentPost.
Output
​
string
Unique identifier for the domain record.
​
string
The domain name you added.
​
string
Initial domain status. Typically "pending_dns" immediately after adding.
​
string
Token used to verify domain ownership via DNS.
​
string
A human-readable description of the next steps.
DNS records are set up asynchronously. Wait a moment after calling AddDomain, then call VerifyDomain to retrieve the required DNS records and check their status.

​
ListDomains

Lists all custom domains on your account with their verification status and sending capability. Inputs This tool takes no inputs. Output
​
integer
Total number of domains on your account.
​
array

​
VerifyDomain

Triggers a DNS verification check for a custom domain. Checks DKIM, SPF, and DMARC records against what the sending provider expects. If all checks pass and the domain is in pending_dns status, the domain transitions to pending_warmup and a warmup period begins (default 72 hours). You can call this tool multiple times to re-check DNS records. Inputs
​
string
required
The domain name to verify (e.g., "example.com"). You must own this domain.
Output
​
string
The domain name that was checked.
​
string
Updated domain status after the verification attempt.
​
boolean
Whether all DNS checks passed.
​
string
ISO 8601 timestamp of when the domain passed verification. null if verification has not passed yet.
​
string
ISO 8601 timestamp of when the warmup period ends. null if not in warmup.
​
object
Results of individual DNS record checks. Includes results for DKIM, SPF, and DMARC records.

​
RemoveDomain

Removes a custom domain from your account and from the sending provider. Mailboxes on the domain lose sending capability immediately.
This action is irreversible. All mailboxes on the domain will lose sending capability. If the provider removal fails, the domain record is still deleted locally.
Inputs
​
string
required
The domain name to remove (e.g., "example.com"). You must own this domain.
Output
​
boolean
Always true when the domain was successfully removed.
​
string
The domain name that was removed.