Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Domain Contacts

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Contacts

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

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • 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" : [
            {
                "nickname" : "Default Example",
                "contact_name" : "Jane Doe",
                "organisation" : "ACME Ltd",
                "phone_number" : "+44.3301226000",
                "fax_number" : "+44.3301226000",
                "email_address" : "example@example.com",
                "street_one" : "Westbury House",
                "street_two" : "15 Bury Street",
                "street_three" : "",
                "city" : "Guildford",
                "state" : "Surrey",
                "zip" : "GU2 4AW",
                "country_code" : "GB",
                "is_validated" : false,
                "is_default" : true,
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-12-14",
                "updated_on" : "2017-12-14"
            }
        ],
        "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" : {
            "nickname" : "Default Example",
            "contact_name" : "Jane Doe",
            "organisation" : "ACME Ltd",
            "phone_number" : "+44.3301226000",
            "fax_number" : "+44.3301226000",
            "email_address" : "example@example.com",
            "street_one" : "Westbury House",
            "street_two" : "15 Bury Street",
            "street_three" : "",
            "city" : "Guildford",
            "state" : "Surrey",
            "zip" : "GU2 4AW",
            "country_code" : "GB",
            "is_validated" : false,
            "is_default" : true,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "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:

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

    Response Details

    201 Response

    {
        "result" : {
            "nickname" : "Default Example",
            "contact_name" : "Jane Doe",
            "organisation" : "ACME Ltd",
            "phone_number" : "+44.3301226000",
            "fax_number" : "+44.3301226000",
            "email_address" : "example@example.com",
            "street_one" : "Westbury House",
            "street_two" : "15 Bury Street",
            "street_three" : "",
            "city" : "Guildford",
            "state" : "Surrey",
            "zip" : "GU2 4AW",
            "country_code" : "GB",
            "is_validated" : false,
            "is_default" : true,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "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:

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

    Response Details

    200 Response

    {
        "result" : {
            "nickname" : "Default Example",
            "contact_name" : "Jane Doe",
            "organisation" : "ACME Ltd",
            "phone_number" : "+44.3301226000",
            "fax_number" : "+44.3301226000",
            "email_address" : "example@example.com",
            "street_one" : "Westbury House",
            "street_two" : "15 Bury Street",
            "street_three" : "",
            "city" : "Guildford",
            "state" : "Surrey",
            "zip" : "GU2 4AW",
            "country_code" : "GB",
            "is_validated" : false,
            "is_default" : true,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "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}/validate

    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

    JSON all-fields example:

    {}

    Response Details

    200 Response

    {
        "result" : {
            "nickname" : "Default Example",
            "contact_name" : "Jane Doe",
            "organisation" : "ACME Ltd",
            "phone_number" : "+44.3301226000",
            "fax_number" : "+44.3301226000",
            "email_address" : "example@example.com",
            "street_one" : "Westbury House",
            "street_two" : "15 Bury Street",
            "street_three" : "",
            "city" : "Guildford",
            "state" : "Surrey",
            "zip" : "GU2 4AW",
            "country_code" : "GB",
            "is_validated" : false,
            "is_default" : true,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "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"
    }
  • PUT/dom/contact/{uuid}/validate

    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" : {
            "nickname" : "Default Example",
            "contact_name" : "Jane Doe",
            "organisation" : "ACME Ltd",
            "phone_number" : "+44.3301226000",
            "fax_number" : "+44.3301226000",
            "email_address" : "example@example.com",
            "street_one" : "Westbury House",
            "street_two" : "15 Bury Street",
            "street_three" : "",
            "city" : "Guildford",
            "state" : "Surrey",
            "zip" : "GU2 4AW",
            "country_code" : "GB",
            "is_validated" : false,
            "is_default" : true,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "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"
    }
View Desktop Site