Domains Contacts - Domain Name API

Create, manage and query contacts used for domain name registrations.

• GET/dom/contact

  Gets all contacts on the account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "city" : "Guildford",
              "contact_name" : "Jane Doe",
              "country_code" : "GB",
              "created_on" : "2021-04-15",
              "email_address" : "example@example.com",
              "fax_number" : "+44.3301226000",
              "is_default" : true,
              "is_validated" : false,
              "nickname" : "Default Example",
              "organisation" : "ACME Ltd",
              "phone_number" : "+44.3301226000",
              "state" : "Surrey",
              "street_one" : "Westbury House",
              "street_three" : "",
              "street_two" : "15 Bury Street",
              "updated_on" : "2021-04-15",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
              "zip" : "GU2 4AW"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/dom/contact/{uuid}

  Gets a specific contact on the account

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Contact to be queried

  Response Details

  200 Response

  {
      "result" : {
          "city" : "Guildford",
          "contact_name" : "Jane Doe",
          "country_code" : "GB",
          "created_on" : "2021-04-15",
          "email_address" : "example@example.com",
          "fax_number" : "+44.3301226000",
          "is_default" : true,
          "is_validated" : false,
          "nickname" : "Default Example",
          "organisation" : "ACME Ltd",
          "phone_number" : "+44.3301226000",
          "state" : "Surrey",
          "street_one" : "Westbury House",
          "street_three" : "",
          "street_two" : "15 Bury Street",
          "updated_on" : "2021-04-15",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zip" : "GU2 4AW"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• POST/dom/contact

  Creates a new Contact

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • city

    • String

    • True

    The postal city for this contact

  • • contact_name

    • String

    • True

    The contact name

  • • country_code

    • String

    • True

    The two letter ISO code for this contacts country

  • • email_address

    • String

    • True

    The email address for this contact

  • • fax_number

    • String

    • False

    The fax number for this contact

  • • is_default

    • boolean

    • False

    Indicates if this contact is the primary contact on the account

  • • nickname

    • String

    • False

    The nickname for this Contact object

  • • organisation

    • String

    • False

    The organisation name for this contact

  • • phone_number

    • String

    • True

    The phone number for this contact

  • • state

    • String

    • True

    The postal state or province for this contact

  • • street_one

    • String

    • True

    First line of the contacts postal address

  • • street_three

    • String

    • False

    Third line of the contacts postal address

  • • street_two

    • String

    • False

    Second line of the contacts postal address

  • • zip

    • String

    • True

    The postal code or ZIP code for this contact

  JSON all-fields example:

  {
      "city" : "Guildford",
      "contact_name" : "Jane Doe",
      "country_code" : "GB",
      "email_address" : "example@example.com",
      "fax_number" : "+44.3301226000",
      "is_default" : true,
      "nickname" : "Default Example",
      "organisation" : "ACME Ltd",
      "phone_number" : "+44.3301226000",
      "state" : "Surrey",
      "street_one" : "Westbury House",
      "street_three" : "",
      "street_two" : "15 Bury Street",
      "zip" : "GU2 4AW"
  }

  Response Details

  201 Response

  {
      "result" : {
          "city" : "Guildford",
          "contact_name" : "Jane Doe",
          "country_code" : "GB",
          "created_on" : "2021-04-15",
          "email_address" : "example@example.com",
          "fax_number" : "+44.3301226000",
          "is_default" : true,
          "is_validated" : false,
          "nickname" : "Default Example",
          "organisation" : "ACME Ltd",
          "phone_number" : "+44.3301226000",
          "state" : "Surrey",
          "street_one" : "Westbury House",
          "street_three" : "",
          "street_two" : "15 Bury Street",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zip" : "GU2 4AW"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

• PUT/dom/contact/{uuid}

  Updates an existing Contact

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the contact to be updated

  PUT body

  • Name

  • Type

  • Required

  • • city

    • String

    • True

    The postal city for this contact

  • • contact_name

    • String

    • True

    The contact name

  • • country_code

    • String

    • True

    The two letter ISO code for this contacts country

  • • email_address

    • String

    • True

    The email address for this contact

  • • fax_number

    • String

    • False

    The fax number for this contact

  • • is_default

    • boolean

    • False

    Indicates if this contact is the primary contact on the account

  • • nickname

    • String

    • False

    The nickname for this Contact object

  • • organisation

    • String

    • False

    The organisation name for this contact

  • • phone_number

    • String

    • True

    The phone number for this contact

  • • state

    • String

    • True

    The postal state or province for this contact

  • • street_one

    • String

    • True

    First line of the contacts postal address

  • • street_three

    • String

    • False

    Third line of the contacts postal address

  • • street_two

    • String

    • False

    Second line of the contacts postal address

  • • zip

    • String

    • True

    The postal code or ZIP code for this contact

  JSON all-fields example:

  {
      "city" : "Guildford",
      "contact_name" : "Jane Doe",
      "country_code" : "GB",
      "email_address" : "example@example.com",
      "fax_number" : "+44.3301226000",
      "is_default" : true,
      "nickname" : "Default Example",
      "organisation" : "ACME Ltd",
      "phone_number" : "+44.3301226000",
      "state" : "Surrey",
      "street_one" : "Westbury House",
      "street_three" : "",
      "street_two" : "15 Bury Street",
      "zip" : "GU2 4AW"
  }

  Response Details

  200 Response

  {
      "result" : {
          "city" : "Guildford",
          "contact_name" : "Jane Doe",
          "country_code" : "GB",
          "created_on" : "2021-04-15",
          "email_address" : "example@example.com",
          "fax_number" : "+44.3301226000",
          "is_default" : true,
          "is_validated" : false,
          "nickname" : "Default Example",
          "organisation" : "ACME Ltd",
          "phone_number" : "+44.3301226000",
          "state" : "Surrey",
          "street_one" : "Westbury House",
          "street_three" : "",
          "street_two" : "15 Bury Street",
          "updated_on" : "2021-04-15",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zip" : "GU2 4AW"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• DELETE/dom/contact/{uuid}

  Deletes an existing Contact

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the contact to be deleted

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• POST/dom/contact/{uuid}/validation

  Validate an existing contact using the email validation code

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the contact to be validated

  POST body

  • Name

  • Type

  • Required

  • • code

    • String

    • True

    The validation code for this contact

  JSON all-fields example:

  {
      "code" : "123456"
  }

  Response Details

  200 Response

  {
      "result" : {
          "city" : "Guildford",
          "contact_name" : "Jane Doe",
          "country_code" : "GB",
          "created_on" : "2021-04-15",
          "email_address" : "example@example.com",
          "fax_number" : "+44.3301226000",
          "is_default" : true,
          "is_validated" : false,
          "nickname" : "Default Example",
          "organisation" : "ACME Ltd",
          "phone_number" : "+44.3301226000",
          "state" : "Surrey",
          "street_one" : "Westbury House",
          "street_three" : "",
          "street_two" : "15 Bury Street",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zip" : "GU2 4AW"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• DELETE/dom/contacts/idle

  Deletes any contacts that are not assigned to a domain

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

• PUT/dom/contact/{uuid}/validation

  Resend the validation email for the specific contact

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the contact to be re-validated

  Response Details

  200 Response

  {
      "result" : {
          "city" : "Guildford",
          "contact_name" : "Jane Doe",
          "country_code" : "GB",
          "created_on" : "2021-04-15",
          "email_address" : "example@example.com",
          "fax_number" : "+44.3301226000",
          "is_default" : true,
          "is_validated" : false,
          "nickname" : "Default Example",
          "organisation" : "ACME Ltd",
          "phone_number" : "+44.3301226000",
          "state" : "Surrey",
          "street_one" : "Westbury House",
          "street_three" : "",
          "street_two" : "15 Bury Street",
          "updated_on" : "2021-04-15",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zip" : "GU2 4AW"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }