Domain Contact

/domain-contact

POST

Create a new contact to be used with domain name registrations.

JSON request

name

string

First- and lastname.

brand

string

The brand reference that the contact belongs to. Optional when only one brand exists.

organization

string

Optional, max. length 255.

email_address

string

Contact email address (must be valid and able to receive email).

address

string

Max. 3 lines, 63 characters per line.

zip_code

string

Max. length 16.

state

string

Max. length 255.

city

string

Max. length 255.

country

string

Alpha-2 country code (ex. NL, DE, CA, IR, etc.)

voice

string

Max. length 17, +[0-9]{1,3}.[0-9]{1,14}

fax

string

Optional, max. length 17, +[0-9]{1,3}.[0-9]{1,14}

JSON response

Possible errors

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "name": "First name Last name",
        "organization": "My Organization",
        "email_address": "test-contact@hostcontrol.com",
        "address": "Address line 1\nAddress line 2\nAddress line 3",
        "zip_code": "1234 AB",
        "state": "Some state",
        "city": "Some city",
        "country": "NL",
        "voice": "+31484538930",
        "fax": null
    }
' \
"{{api_base_url}}/domain-contact" | python -m json.tool

/domain-contact

GET

Returns a list of domain contacts.

JSON request

handle

string

Generated identifier of contact. Unique per RTR account

organization

string

Organization name of Contact to search for.

name

string

Contact name to search for.

address

string

Contact address to search for.

state

string

Contact state to search for

zip_code

string

Zip code depending on the selected country during creation of Contact

city

string

Contact city to search for

country

string

Comma separated list of client references that uniquely identifies a domain.

email_address

string

Email address of the Contact.

voice

string

Valid phone number of Contact to search for.

fax

string

Valid fax number of Contact to search for.

JSON response

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain-contact" | python -m json.tool

/domain-contact/{id}

GET

JSON response

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain-contact/{id}" | python -m json.tool

PUT

Update an existing contact.

JSON request

name

string

First- and lastname.

organization

string

Optional, max. length 255.

email_address

string

Contact email address (must be valid and able to receive email).

address

string

Max. 3 lines, 63 characters per line.

zip_code

string

Max. length 16.

state

string

Max. length 255.

city

string

Max. length 255.

country

string

Alpha-2 country code (ex. NL, DE, CA, IR, etc.).

voice

string

Max. length 17, +[0-9]{1,3}.[0-9]{1,14}

fax

string

Optional, max. length 17, +[0-9]{1,3}.[0-9]{1,14}

designated_agent

string

OPTIONAL: Possible values: ‘NONE’, ‘OLD’, ‘NEW’, ‘BOTH’ Indicates for whom you are acting as a designated agent. If a registry does not allow you to be designated agent or interaction with the registrant is still required this parameter is silently ignored.

JSON response

Possible errors

Sample

curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "name": "First name Last name",
        "organization": "My Organization",
        "email_address": "test-contact@hostcontrol.com",
        "address": "Address line 1\nAddress line 2\nAddress line 3",
        "zip_code": "1234 AB",
        "state": "Some state",
        "city": "Some city",
        "country": "NL",
        "voice": "+31484538930",
        "fax": null
    }
' \
"{{api_base_url}}/domain-contact/{id}" | python -m json.tool

DELETE

Possible errors

Sample

curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain-contact/{id}" | python -m json.tool

/domain-contact/{id}/validation

GET

Get the validation status for given contact.

JSON response

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain-contact/{id}/validation" | python -m json.tool

POST

Start a preemptive validation of a contact or send a reminder for an active contact validation.

JSON request

categories

array

One or more categories to request validation for. Values should be one of:
  • General: General terms and conditions

  • IisNu: .NU registry terms and conditions

  • IisSe: .SE registry terms and condition

  • Esnic: .ES registry terms and condition

  • Nominet: .UK registry terms and condition

JSON response

Possible errors

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "categories": ["General"]
    }
' \
"{{api_base_url}}/domain-contact/{id}/validation" | python -m json.tool