Create Address Endpoint

post

https://{server}/ns-api/v2/domains/{domain}/addresses/endpoints

Path Params

domain

string

required

length ≤ 64

Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Body Params

address-callback-number

This will match the callback number

address-name

string

required

This is the name label for the address

caller-name

string

required

This is the caller's name for the address

address-line-1

string

This is the address line 1 for the address

address-line-2

string | null

This is the address line 2 for the address

address-city

string

This is the city for the address

address-state-province-abbreviation

string

This is the state or province (Canadian) abbreviation for the address

address-postal-code

string

This is the postal code for the address

address-country-abbreviation

string

This is the country appreviation for the address

address-location-description

string | null

This is an optional location description for the address

carrier

string | null

This is the carrier name for the address

location-id

string | null

This is the address-id in cases for creation using an existing address. For create/update either location-id or address-formatted-pidflo is needed

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted

400Bad Request

401Authentication Required

404Record not found