Loading

Error Sorry

Yay.com - VoIP Business Phone Service Provider
  • Voice
    • Compare Voice Plans
    • Call Costs
    • Voice Features
    • Chat Features
    • Hosted Voice Reseller
    • VoIP Free 14 Day Trial
    • Business Phone Systems
  • Phone Numbers
    • All Phone Numbers
    • Transfer your Phone Number
    • New York 917 Numbers
    • Los Angeles 213 Numbers
    • Chicago 773 Numbers
    • Houston 832 Numbers
    • San Francisco 628 Numbers
    • Seattle 206 Numbers
    • Washington DC 202 Numbers
    • International Phone Numbers
  • Domain Names
    • Domain Name Search
    • Domain Transfer
    • Domain Backorders
    • Domain Registration Pricing
    • Bulk Domain Name Search
    • Domain Name Registration
    • Domain Name Reseller
  • Downloads
    • Download for Desktop
    • Download for iOS
    • Download for Android
  • Integrations
    • Phone System Integrations
    • Microsoft Teams Direct Routing
    • VoIP API Docs
    • Domain Name API Docs
  • Help & About
    • About us
    • Policy & Accreditations
    • Reviews
    • Frequent Questions
    • Read Blog
    • VoIP News
    • Contact us
  • Hello! Log in Your Account

    Log in

    New customer? Start here

  • 0

    Cart Total

    $0.00


    • Your shopping cart is empty


    Checkout

    Delete everything ?

Yay.com - VoIP Business Phone Service Provider
0
  • Voice

    • Compare Voice Plans
    • Call Costs
    • Voice Features
    • Chat Features
    • Hosted Voice Reseller
    • VoIP Free 14 Day Trial
    • Business Phone Systems
  • Phone Numbers

    • All Phone Numbers
    • Transfer your Phone Number
    • New York 917 Numbers
    • Los Angeles 213 Numbers
    • Chicago 773 Numbers
    • Houston 832 Numbers
    • San Francisco 628 Numbers
    • Seattle 206 Numbers
    • Washington DC 202 Numbers
    • International Phone Numbers
  • Domain Names

    • Domain Name Search
    • Domain Transfer
    • Domain Backorders
    • Domain Registration Pricing
    • Bulk Domain Name Search
    • Domain Name Registration
    • Domain Name Reseller
  • Integrations

    • Phone System Integrations
    • Microsoft Teams Direct Routing
    • VoIP API Docs
    • Domain Name API Docs
  • Downloads

    • Download for Desktop
    • Download for iOS
    • Download for Android
  • Help & About

    • About us
    • Policy & Accreditations
    • Reviews
    • Frequent Questions
    • Read Blog
    • VoIP News
    • Contact us

Cart Total

$0.00

  • Your shopping cart is empty

Checkout

Delete everything ?

Domain Contacts

  • Domain Management

    • Activity Logs
    • Availability
    • Domain Back Order
    • Domain Names
    • Domain Transfer
    • Host Names
    • TLD Pricing
  • Domain Contacts

    • Domains Contacts
  • Name Server Groups

    • Name Server Groups
  • DNZ Zones and Records

    • DNS Records
    • DNS Templates
    • DNS Zones
  • Email and Web Forwarding

    • Email Forwarding
    • Web Forwarding
  • SSL Certificates

    • Private Keys
    • SSL Certificates

API Access

Build custom apps using our JSON API

Configure API
Yay.com Customer Reviews
apple-store google-play

Latest

News

  • Enhance Support With Our Intercom App Phone Integration
    Adrian - Digital Marketing at Yay.com

    Adrian - December 20 2022

  • Yay.com Receives Private Equity Investment To Accelerate Channel Offering
    Adrian - Digital Marketing at Yay.com

    Adrian - November 25 2022

  • Yay.com Awarded G-Cloud 13 Supplier Status
    Adrian - Digital Marketing at Yay.com

    Adrian - November 22 2022

Domains Contacts - Domain Name API

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

Become a Reseller

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" : [
            {
                "city" : "Guildford",
                "contact_name" : "Jane Doe",
                "country_code" : "GB",
                "created_on" : "2023-02-07",
                "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" : "2023-02-07",
                "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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" : "2023-02-07",
            "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"
    }
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service
  • VoIP Provider

    VoIP Provider

    Business VoIP Number Transfer number to VoIP Cloud PBX Phone System PAYG VoIP Call Costs VoIP Phone Numbers Business Phone System Features
  • Hosted VoIP Plans

    Hosted VoIP Plans

    VoIP Trial Account Business VoIP
    SIP Trunks
    SIP Provider SIP Trunking
  • Resellers

    Resellers

    VoIP Reseller Domain Reseller White Label VoIP Reseller
    Domain Names

    Domain Names

    Domain Name Search Domain Transfer Backorder Domains Domain Name Registration Domain Name Features
  • Help & Contact

    Help & Contact

    Contact Us Frequently Asked Questions Download Yay.com Apps Advantages of VoIP What is VoIP? VoIP Beginner's Guide VoIP API Documentation Domain API Documentation
  • Login / Register

    Login / Register

    About Yay Our News Our Blogs Terms & Conditions Privacy Policy
  • Accreditations
    ISO 27001 ISO 22301 Cyber Essentials G. Cloud Framework
Yay.com Business Phone Systems on YouTube Yay.com Business Phone Systems on Twitter Yay.com Business Phone Systems on Facebook Yay.com Business Phone Systems on LinkedIn
Yay.com - Business Phone Systems
About Yay! Terms & Conditions Privacy Policy
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service
  • About Yay!
  • Terms & Conditions
  • Privacy Policy
  • Contact us
  • Frequent Questions
  • (888) YAY-8747

  • help@yay.com

  • ©2023 Yay.com

  • Yay.com - VoIP Business Phone Service Provider

26 Broadway, 8th Floor, New York, NY, 10004