Skip to main content
PATCH
/
domains
/
{id}
cURL
curl --request PATCH \
  --url https://api.useanima.sh/v1/domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbackEnabled": true
}
'
{
  "id": "<string>",
  "domain": "<string>",
  "verified": true,
  "verificationCooldownUntil": "2023-11-07T05:31:56Z",
  "verificationToken": "<string>",
  "dkimSelector": "<string>",
  "dkimPublicKey": "<string>",
  "spfConfigured": true,
  "dmarcConfigured": true,
  "mxConfigured": true,
  "feedbackEnabled": true,
  "records": [
    {
      "name": "<string>",
      "value": "<string>",
      "priority": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Path Parameters

​
id
string
required

Unique domain identifier

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

Domain update parameters

​
feedbackEnabled
boolean

Whether to enable bounce and complaint feedback processing for this domain

Response

200 - application/json

OK

Full domain resource representation with verification and DNS status

​
id
string
required

Unique identifier of the domain

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
​
domain
string
required

Fully qualified domain name

​
status
enum<string>
required

Current verification status

Available options:
NOT_STARTED,
PENDING,
VERIFYING,
VERIFIED,
INVALID,
FAILED
​
verified
boolean
required

Whether the domain has been fully verified

​
verificationCooldownUntil
string<date-time> | null
required

Earliest time a re-verification can be attempted, or null if no cooldown

​
verificationToken
string
required

Token value to place in DNS records for verification

​
verificationMethod
enum<string>
required

DNS record method used for domain verification

Available options:
DNS_TXT,
DNS_CNAME
​
dkimSelector
string | null
required

DKIM selector used for email signing, or null if not configured

​
dkimPublicKey
string | null
required

DKIM public key for DNS publication, or null if not configured

​
spfConfigured
boolean
required

Whether SPF DNS records are correctly configured

​
dmarcConfigured
boolean
required

Whether DMARC DNS records are correctly configured

​
mxConfigured
boolean
required

Whether MX DNS records are correctly configured

​
feedbackEnabled
boolean
required

Whether bounce and complaint feedback processing is enabled

​
records
object[] | null
required

Required DNS records for this domain, or null if not yet generated

​
createdAt
string<date-time>
required

Timestamp when the domain was added