domains
PUT /v1/domains/{domainId}/settings
Change a domain's registrar settings.
Authentication
Send an API key as a bearer token. The key must carry the domains.dns.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/domains/{domainId}/settings \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
A partial update: an omitted field is left alone, never reset. Each changed flag is applied at the registrar first and mirrored onto our record only once it succeeds — so this endpoint never reports a protection (a transfer lock, WHOIS privacy) that the registrar has not actually applied. auto_renew is decided here and a registrar that keeps its own auto-renew flag is made to agree with it, registrar first and read back (#7175) — so switching it off can never leave the registrar renewing and charging on its own. (On the Cloudflare route switching it on is applied by the renewal sweep once the renewal is paid.) A registrar that refuses or ignores the change is a 503. Requires domains.dns.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
domainId (path) | Uuid | Yes | The domain's id. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
auto_renew | boolean | No | — |
transfer_lock | boolean | No | — |
dnssec_enabled | boolean | No | — |
privacy_enabled | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
registrar | string | Yes | The registrar driver holding this domain (a driver name, never a vendor id). |
auto_renew | boolean | Yes | Whether we renew it before expiry. Ours, not the registrar's. |
transfer_lock | boolean | Yes | Registrar transfer lock (clientTransferProhibited) — blocks an outbound transfer. |
dnssec_enabled | boolean | Yes | — |
privacy_enabled | boolean | Yes | WHOIS privacy / registrant redaction, where the TLD supports it. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503