Sign in

v5

latestOpenAPI 3.0.0MIT2026-08-041554551.6 MB
Domains

Update a domain

Updates optional domain fields. When data is provided, it replaces the entire metadata object; omit data to leave it unchanged.

patch/v1/domains/{domain}

Path parameters

domainstring required

Request body

dataobject

Replaces domain metadata when provided (max 10 keys, 500 characters total for keys+values).

Response

OK

_idstring required
namestring required
status'pending' | 'verified' required
mxRecordConfiguredboolean required
dnsProviderstring
_environmentIdstring required
_organizationIdstring required
createdAtstring required
updatedAtstring required
dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).

Example response

{
  "expectedDnsRecords": [
    {
      "type": "MX",
      "name": "inbound",
      "content": "inbound-smtp.us-east-1.amazonaws.com",
      "ttl": "Auto",
      "priority": 10
    }
  ]
}