Several endpoints share the same nested parameter shapes. This page documents each model and how to encode it as application/x-www-form-urlencoded.

​
Form-encoding

All nested parameters use PHP http_build_query bracket notation. Objects use named keys, arrays use numeric or empty brackets:
  • Object field: contacts[registrant][firstname]=Jane
  • Array of scalars: tldsToInclude[]=.com
  • Array of objects: dnsrecords[0][hostname]=@
The examples under each model below show the exact keys to send.

​
Contact

A single contact. Used inside Contacts and Contact details.
​
text
required
First name.
​
text
required
Last name.
​
text
required
Full name.
​
text
required
Company name.
​
text
required
Email address.
​
text
required
Street address, line 1.
​
text
Street address, line 2.
​
text
required
City.
​
text
required
State or province.
​
text
required
Postal or ZIP code.
​
text
required
Two-letter country code.
​
text
required
Phone number.

​
Contacts

The contacts parameter used by register and transfer. Each key is a Contact object. Keys are lowercase.
​
contact
required
The domain registrant.
​
contact
Technical contact.
​
contact
Billing contact.
​
contact
Administrative contact.

​
Contact details

The contactdetails parameter used by POST /domains/{domain}/contact in Contacts. Each key is a Contact object.
The keys here are capitalized — Registrant, Technical, Billing, Admin — and differ from the lowercase contacts keys used when ordering. Use the exact casing shown.
​
contact
required
The domain registrant.
​
contact
required
Technical contact.
​
contact
required
Billing contact.
​
contact
required
Administrative contact.

​
Nameservers

The nameservers parameter used by register, transfer, and POST /domains/{domain}/nameservers. Up to five nameservers; the first two are required.
​
text
required
Primary nameserver.
​
text
required
Secondary nameserver.
​
text
Third nameserver.
​
text
Fourth nameserver.
​
text
Fifth nameserver.

​
DNS records

The dnsrecords parameter used by POST /domains/{domain}/dns in DNS. An array of record objects, indexed from 0.
​
text
required
Record host, for example @ or www.
​
text
required
Record type, for example A, CNAME, or MX.
​
text
required
Record value or target.
​
numeric
required
Priority, for example 0. Used by MX and SRV records.
​
text
Record ID. Present on existing records; omit when creating a new one.

​
Addons

The addons parameter used by register, transfer, and renew. Each field is 1 (on) or 0 (off).
​
numeric
DNS management, 1 or 0.
​
numeric
Email forwarding, 1 or 0.
​
numeric
ID protection, 1 or 0.