Account

Update domain-order settings

PATCH
/v1/account/domains

The registrant every order falls back to, absent a per-order one; POST /domains can still send its own for a single order, and is refused with registrant_required when there is neither. null clears it. Changing any field of a contact already stored drops the registrar's handle and validation for it; sending back the exact same contact keeps them. privacyByDefault adds WHOIS privacy to new registrations wherever the ending offers it. autoRenewByDefault turns auto-renew on for new registrations. digestEnabled turns the weekly expiry digest email off. Live and sandbox keep their own.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Request Body

application/json
  1. body
defaultRegistrant?|null
privacyByDefault?boolean

New registrations get WHOIS privacy wherever the ending offers it. An ending that does not offer it is registered without it rather than refused

autoRenewByDefault?boolean

New registrations renew themselves from your wallet

digestEnabled?boolean

The weekly email of domains expiring soon or failing to auto-renew

Response Body

Success

application/json
  1. response

Success

defaultRegistrant*|

The registrant every order falls back to, absent a per-order one. Null until set, and then an order that sends none of its own is refused

privacyByDefault*boolean

New registrations get WHOIS privacy wherever the ending offers it. An ending that does not offer it is registered without it rather than refused

autoRenewByDefault*boolean

New registrations renew themselves from your wallet. Off until turned on

digestEnabled*boolean

The weekly email of domains expiring soon or failing to auto-renew. On until turned off

actor*|

Who last updated these domain settings

curl -X PATCH "https://example.com/v1/account/domains" \  -H "Content-Type: application/json" \  -d '{}'
{  "defaultRegistrant": {    "name": "Jo Bloggs",    "organization": "Northwind Telecom",    "email": "[email protected]",    "phone": "+1 415 555 0132",    "address": "1 Market Street",    "city": "San Francisco",    "state": "CA",    "postalCode": "94105",    "country": "US",    "validation": "pending"  },  "privacyByDefault": true,  "autoRenewByDefault": true,  "digestEnabled": true,  "actor": {    "kind": "user",    "label": "string"  }}