Deployments.ai Docs
Agent Email

Revoke a custom email domain

POST /v1/agent-email/domains/{domainId}/revoke · SDK revokeAgentEmailDomain · CLI deployments inbox-domain revoke

POST
/v1/agent-email/domains/{domainId}/revoke

Requires agent-email:admin.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

domainId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string
Length1 <= length <= 512

Response Body

AgentEmailDomainResponse

application/json
  1. response
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
dnsRecords*array<>
domain*string
failureReason?string
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
lastCheckedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
mailFromDomain*string
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
placementId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
providerIdentity?string
providerManaged*boolean
providerMetadata*
status*string
Value in"failed""pending""pending_dns""provisioning""revoked""verified"
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
verifiedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
curl -X POST "https://example.com/v1/agent-email/domains/string/revoke" \  -H "x-deployments-environment: string" \  -H "idempotency-key: string"
{  "createdAt": "2019-08-24T14:15:22Z",  "dnsRecords": [    {      "name": "string",      "priority": 0,      "type": "CNAME",      "value": "string"    }  ],  "domain": "string",  "failureReason": "string",  "id": "string",  "lastCheckedAt": "2019-08-24T14:15:22Z",  "mailFromDomain": "string",  "organizationId": "string",  "placementId": "string",  "providerIdentity": "string",  "providerManaged": true,  "providerMetadata": {    "property1": null,    "property2": null  },  "status": "failed",  "updatedAt": "2019-08-24T14:15:22Z",  "verifiedAt": "2019-08-24T14:15:22Z"}