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 ?

Customer Management

  • Storefronts

    • Invoices
    • Credit Notes
  • Customer Management

    • Reseller Account Balances
    • Reseller Addresses
    • Sub Resellers
    • Reseller Users
    • Documents
    • Storefronts
    • Integrations
    • Bank Accounts
    • Revenue Withdrawal
    • Discount
  • VoIP Bundle (Subscriptions)

    • VoIP Subscription Bundle
  • SIP Account Management

    • Hunt Groups
    • SIP Users
    • App Configuration
  • Audio Management

    • Sounds
    • Playlists
  • Phone Numbers & Call Routing

    • Call Flows, Call Route
    • Number Transfers
    • Time Diaries
    • Phone Numbers
    • Number Search
    • Emergency Address
    • Number Address
  • Phone Calls & CDR Data

    • Phone Call Packs
    • Call Recording Retention
    • Phone Call Costs
    • Phone Call History
    • Phone Call Restrictions
    • Outbound Calls
    • Call Statistics Reporting
    • Missed Call Notifications
    • Call Statistics
    • Outbound Calls
  • VoIP Phone Short Code

    • Short Codes
  • eFax Management

    • Fax Messages
    • Fax Authorized Senders
  • Voicemails & Mailboxes

    • Mailboxes
    • Mailbox Menus
    • Mailbox Email Recipients
    • Mailbox Messages
  • Caller ID

    • Caller IDs
    • Caller ID Requests
  • SIP Trunks

    • Trunk Authentication
    • VoIP Trunks
  • Wallboard Statistics

  • VoIP Phone Provisioning

    • Devices
  • Call Queueing

    • Queue Stats
    • Queue Notices
    • Queue Groups
  • Phone Books

    • Phone Book
    • Phone Book Contact
  • VoIP Phone Speed Dial

    • Speed Dials
  • Text (SMS) Messaging

    • Text Message Campaign

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

Sub Resellers

Create and Manage Sub Resellers of your account

Become a Reseller

Filter:

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

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

  • GET/account/reseller

    Gets the details of all active sub resellers 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" : [
            {
                "addresses" : [
                    {
                        "city" : "Exampleton",
                        "country_code" : "GB",
                        "created_on" : "2023-02-07",
                        "state" : "",
                        "street_one" : "1 Example Street",
                        "street_three" : "",
                        "street_two" : "",
                        "updated_on" : "2023-02-07",
                        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                        "zip" : "EX4M PL3"
                    }
                ],
                "allow_outbound" : true,
                "contact_name" : "Pete's Plumbing and Electrical",
                "created_on" : "2023-02-07",
                "ip_addresses" : [
                    {
                        "created_on" : "2023-02-07",
                        "ip_range" : "255.255.255.255/32"
                    }
                ],
                "name" : "Example Sub Reseller",
                "phone" : "+443301226000",
                "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
                "updated_on" : "2023-02-07",
                "users" : [
                    {
                        "contact_first_name" : "Pete",
                        "contact_last_name" : "Plumber",
                        "created_on" : "2023-02-07",
                        "email" : "pete@example.com",
                        "name" : "pete_the_plumber",
                        "password" : "password",
                        "role_id" : 1,
                        "updated_on" : "2023-02-07",
                        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
                    }
                ],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/account/reseller/{uuid}

    Gets the details for a specific sub reseller 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 Sub Reseller to be queried

    Response Details

    200 Response

    {
        "result" : {
            "addresses" : [
                {
                    "city" : "Exampleton",
                    "country_code" : "GB",
                    "created_on" : "2023-02-07",
                    "state" : "",
                    "street_one" : "1 Example Street",
                    "street_three" : "",
                    "street_two" : "",
                    "updated_on" : "2023-02-07",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "zip" : "EX4M PL3"
                }
            ],
            "allow_outbound" : true,
            "contact_name" : "Pete's Plumbing and Electrical",
            "created_on" : "2023-02-07",
            "ip_addresses" : [
                {
                    "created_on" : "2023-02-07",
                    "ip_range" : "255.255.255.255/32"
                }
            ],
            "name" : "Example Sub Reseller",
            "phone" : "+443301226000",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "updated_on" : "2023-02-07",
            "users" : [
                {
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "created_on" : "2023-02-07",
                    "email" : "pete@example.com",
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "role_id" : 1,
                    "updated_on" : "2023-02-07",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/account/reseller

    Creates a new sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • False

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • phone

      • String

      • False

      The phone number for this Reseller

      • store_front

      • String

      • False

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • False

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.
      Valid roles are

      • 1 - API Admin
      • 3 - Storefront User

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "addresses" : [
            {
                "city" : "Exampleton",
                "country_code" : "GB",
                "state" : "",
                "street_one" : "1 Example Street",
                "street_three" : "",
                "street_two" : "",
                "zip" : "EX4M PL3"
            }
        ],
        "contact_name" : "Pete's Plumbing and Electrical",
        "name" : "Example Sub Reseller",
        "phone" : "+443301226000",
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
        "users" : [
            {
                "contact_first_name" : "Pete",
                "contact_last_name" : "Plumber",
                "email" : "pete@example.com",
                "name" : "pete_the_plumber",
                "password" : "password",
                "role_id" : 1
            }
        ]
    }

    Response Details

    201 Response

    {
        "result" : {
            "addresses" : [
                {
                    "city" : "Exampleton",
                    "country_code" : "GB",
                    "created_on" : "2023-02-07",
                    "state" : "",
                    "street_one" : "1 Example Street",
                    "street_three" : "",
                    "street_two" : "",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "zip" : "EX4M PL3"
                }
            ],
            "allow_outbound" : true,
            "contact_name" : "Pete's Plumbing and Electrical",
            "created_on" : "2023-02-07",
            "ip_addresses" : [
                {
                    "created_on" : "2023-02-07",
                    "ip_range" : "255.255.255.255/32"
                }
            ],
            "name" : "Example Sub Reseller",
            "phone" : "+443301226000",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "users" : [
                {
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "created_on" : "2023-02-07",
                    "email" : "pete@example.com",
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "role_id" : 1,
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/account/reseller/{uuid}

    Updates a sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller to be updated

    PUT body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • False

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • phone

      • String

      • False

      The phone number for this Reseller

      • store_front

      • String

      • False

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • False

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.
      Valid roles are

      • 1 - API Admin
      • 3 - Storefront User

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "contact_name" : "Pete's Plumbing and Electrical",
        "name" : "Example Sub Reseller",
        "phone" : "+443301226000",
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7"
    }

    Response Details

    200 Response

    {
        "result" : {
            "addresses" : [
                {
                    "city" : "Exampleton",
                    "country_code" : "GB",
                    "created_on" : "2023-02-07",
                    "state" : "",
                    "street_one" : "1 Example Street",
                    "street_three" : "",
                    "street_two" : "",
                    "updated_on" : "2023-02-07",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "zip" : "EX4M PL3"
                }
            ],
            "allow_outbound" : true,
            "contact_name" : "Pete's Plumbing and Electrical",
            "created_on" : "2023-02-07",
            "ip_addresses" : [
                {
                    "created_on" : "2023-02-07",
                    "ip_range" : "255.255.255.255/32"
                }
            ],
            "name" : "Example Sub Reseller",
            "phone" : "+443301226000",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "updated_on" : "2023-02-07",
            "users" : [
                {
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "created_on" : "2023-02-07",
                    "email" : "pete@example.com",
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "role_id" : 1,
                    "updated_on" : "2023-02-07",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        },
        "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"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • PUT/account/reseller/{uuid}/international-calls-allowed

    Updates whether a sub reseller can make international calls

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller to be updated

    PUT body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • False

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • phone

      • String

      • False

      The phone number for this Reseller

      • store_front

      • String

      • False

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • False

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.
      Valid roles are

      • 1 - API Admin
      • 3 - Storefront User

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "contact_name" : "Pete's Plumbing and Electrical",
        "name" : "Example Sub Reseller",
        "phone" : "+443301226000",
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7"
    }

    Response Details

    200 Response

    {
        "result" : {
            "addresses" : [
                {
                    "city" : "Exampleton",
                    "country_code" : "GB",
                    "created_on" : "2023-02-07",
                    "state" : "",
                    "street_one" : "1 Example Street",
                    "street_three" : "",
                    "street_two" : "",
                    "updated_on" : "2023-02-07",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                    "zip" : "EX4M PL3"
                }
            ],
            "allow_outbound" : true,
            "contact_name" : "Pete's Plumbing and Electrical",
            "created_on" : "2023-02-07",
            "ip_addresses" : [
                {
                    "created_on" : "2023-02-07",
                    "ip_range" : "255.255.255.255/32"
                }
            ],
            "name" : "Example Sub Reseller",
            "phone" : "+443301226000",
            "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7",
            "updated_on" : "2023-02-07",
            "users" : [
                {
                    "contact_first_name" : "Pete",
                    "contact_last_name" : "Plumber",
                    "created_on" : "2023-02-07",
                    "email" : "pete@example.com",
                    "name" : "pete_the_plumber",
                    "password" : "password",
                    "role_id" : 1,
                    "updated_on" : "2023-02-07",
                    "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        },
        "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"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • DELETE/account/reseller/{uuid}

    Deletes the specified sub reseller

    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"
    }

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/account/reseller/{uuid}/unlock

    Unlocks the specified sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    PUT body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • False

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • phone

      • String

      • False

      The phone number for this Reseller

      • store_front

      • String

      • False

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • False

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.
      Valid roles are

      • 1 - API Admin
      • 3 - Storefront User

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "contact_name" : "Pete's Plumbing and Electrical",
        "name" : "Example Sub Reseller",
        "phone" : "+443301226000",
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7"
    }

    Response Details

    204 Response

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

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/account/reseller/{uuid}/lock

    Locks the specified sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    PUT body

    • Name

    • Type

    • Required

      • addresses

      • Array of Reseller Address

      • False

      A list of this Reseller's Addresses

      • contact_name

      • String

      • True

      The contact name for this Reseller

      • name

      • String

      • True

      The name of this Reseller

      • phone

      • String

      • False

      The phone number for this Reseller

      • store_front

      • String

      • False

      The UUID of the Store this Reseller belongs to

      • users

      • Array of Reseller User

      • False

      A list of this Reseller's Users.

    Allowed IP Range

    An Allowed IP Range is a range of IP Addresses in CIDR notation that has been white-listed for access to the API.

      • ip_range

      • String

      • True

      The IP Address Range in CIDR notation

    Reseller User

    A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

      • contact_first_name

      • String

      • False

      This Reseller User's first name

      • contact_last_name

      • String

      • False

      This Reseller User's last name

      • email

      • String

      • True

      This Reseller User's email address

      • name

      • String

      • True

      This Reseller User's username

      • password

      • String

      • True

      This Reseller User's password

      • role_id

      • int

      • True

      This Reseller User's role id, which determines their level of access.
      Valid roles are

      • 1 - API Admin
      • 3 - Storefront User

    Reseller Address

    A Reseller Address is a geographical address used for billing of a reseller

      • city

      • String

      • True

      The town/city of the address

      • country_code

      • String

      • True

      The Country ISO Code

      • state

      • String

      • False

      The county/state of the street address

      • street_one

      • String

      • True

      The first line of the street address

      • street_three

      • String

      • False

      The third line of the street address

      • street_two

      • String

      • False

      The second line of the street address

      • zip

      • String

      • True

      The Zip/Post Code

    JSON all-fields example:

    {
        "contact_name" : "Pete's Plumbing and Electrical",
        "name" : "Example Sub Reseller",
        "phone" : "+443301226000",
        "store_front" : "31347d42-00bd-44a5-9b5c-20dc4197a2f7"
    }

    Response Details

    204 Response

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

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
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