Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
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

Reseller Addresses

A Reseller Address is a geographical address used for billing and delivery for a reseller

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

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

GET/account/reseller-address

Gets a list of all active addresses for a reseller

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "city" : "Guildford",
            "country_code" : "GB",
            "created_on" : "2023-06-04",
            "display_name" : "Billing Address",
            "is_default" : true,
            "state" : "Surrey",
            "street_one" : "1 Example Street",
            "street_three" : "",
            "street_two" : "",
            "updated_on" : "2023-06-04",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "zip" : "GU1 1XX"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/account/reseller-address/{uuid}

Gets the specified reseller address

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Reseller Address to be queried

Response Details

200 Response

{
    "result" : {
        "city" : "Guildford",
        "country_code" : "GB",
        "created_on" : "2023-06-04",
        "display_name" : "Billing Address",
        "is_default" : true,
        "state" : "Surrey",
        "street_one" : "1 Example Street",
        "street_three" : "",
        "street_two" : "",
        "updated_on" : "2023-06-04",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
        "zip" : "GU1 1XX"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

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

POST/account/reseller-address

Creates a new reseller address

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- city
- String
- True
The town/city of the address
- country_code
- String
- True
The 2 character ISO code for the addresses country
- display_name
- String
- False
The nickname to display for this address
- is_default
- boolean
- True
Whether or not this is the default address for this Reseller
- 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:

{
    "city" : "Guildford",
    "country_code" : "GB",
    "display_name" : "Billing Address",
    "is_default" : true,
    "state" : "Surrey",
    "street_one" : "1 Example Street",
    "street_three" : "",
    "street_two" : "",
    "zip" : "GU1 1XX"
}

Response Details

201 Response

{
    "result" : {
        "city" : "Guildford",
        "country_code" : "GB",
        "created_on" : "2023-06-04",
        "display_name" : "Billing Address",
        "is_default" : true,
        "state" : "Surrey",
        "street_one" : "1 Example Street",
        "street_three" : "",
        "street_two" : "",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
        "zip" : "GU1 1XX"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

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

409 Response

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

PUT/account/reseller-address/{uuid}

Updates the specified Reseller Address

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Reseller Address to be updated

PUT body

Name
Type
Required

- city
- String
- True
The town/city of the address
- country_code
- String
- True
The 2 character ISO code for the addresses country
- display_name
- String
- False
The nickname to display for this address
- is_default
- boolean
- True
Whether or not this is the default address for this Reseller
- 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:

{
    "city" : "Guildford",
    "country_code" : "GB",
    "display_name" : "Billing Address",
    "is_default" : true,
    "state" : "Surrey",
    "street_one" : "1 Example Street",
    "street_three" : "",
    "street_two" : "",
    "zip" : "GU1 1XX"
}

Response Details

200 Response

{
    "result" : {
        "city" : "Guildford",
        "country_code" : "GB",
        "created_on" : "2023-06-04",
        "display_name" : "Billing Address",
        "is_default" : true,
        "state" : "Surrey",
        "street_one" : "1 Example Street",
        "street_three" : "",
        "street_two" : "",
        "updated_on" : "2023-06-04",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
        "zip" : "GU1 1XX"
    },
    "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-address/{uuid}

Deletes the specified Reseller Address
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Reseller Address 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"
}
```