Contact tools

Manage org-wide contacts and assign them to domains as registrant, admin, technical, or billing.

A contact is a reusable address record. Each domain has up to four roles: registrant, admin, technical, billing. The same contact can fill more than one role.

list_contacts

Required scope: contacts:read.

org_oid string path required
Organisation OID from whoami.

Returns the org’s contacts.

create_contact

Required scope: contacts:write. Caller must be owner or admin.

org_oid string path required
first_name string path required
last_name string path required
address_one string path required
suburb string path required
state string path required
country string path required
ISO-2 country code (e.g. AU).
postcode string path required
phone string path required
International format (e.g. +61.412345678).
email string path required
organisation string path
Optional company name.
address_two string path
Optional second address line.

update_contact

Replaces an entire contact record — supply every field, not just changed ones.

Required scope: contacts:write. Caller must be owner or admin.

contact_id string path required
Contact UUID.

All other params match create_contact.

delete_contact

Required scope: contacts:write. Caller must be owner or admin.

org_oid string path required
contact_id string path required

Returns { "deleted": true, "contact_id": "..." }.

get_domain_contacts

Required scope: contacts:read.

org_oid string path required
domain string path required

Returns up to four entries — one per assigned role. Missing roles aren’t in the list.

set_domain_contact

Required scope: contacts:write. Caller must be owner or admin.

org_oid string path required
domain string path required
contact_type string path required
One of registrant, admin, technical, billing.
contact_id string path required
UUID from list_contacts.

The change is local. The next sync cycle pushes it to the registrar.

unset_domain_contact

Required scope: contacts:write. Caller must be owner or admin.

org_oid string path required
domain string path required
contact_type string path required
Last updated Edit this page
↑↓ navigate open esc close