Claim an agent domain
POST
/v1/email/agent-domains
curl -X POST "https://us1.platform.bird.com/v1/email/agent-domains" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"handle": "acme-support"
}'Claims your workspace's agent domain. The handle becomes the leftmost label of a Bird-hosted domain that your mailbox addresses live under. Handles are globally unique and immutable; reserved handles (brand, financial, and infrastructure terms) cannot be claimed. Each workspace can hold one active agent domain. Most claims return the domain already active; if setup is still finishing, it is returned with status provisioning — poll it until it becomes active.
Treść żądania
handle
string
wymagane
The handle to claim. Lowercase letters, digits, and hyphens; must start and end with a letter or digit. Handles are globally unique, immutable, and checked against a reserved list — brand, financial, and infrastructure terms cannot be claimed.
Treść odpowiedzi
id
string
wymagane
Agent domain ID.
handle
string
wymagane
The claimed handle — the leftmost label of the agent domain. Immutable.
domain
string
wymagane
The full agent domain that mailbox addresses live under.
status
string
wymagane
Lifecycle status. provisioning domains are being set up and become active shortly — poll the domain until it does. active domains receive mail. releasing domains are being released; once released they no longer receive mail, and the handle stays reserved to this workspace.
released_at
nullable string
When the domain was released. Null while active.
created_at
string
wymagane
When the domain was claimed.
updated_at
string
wymagane
When the domain was last updated.