API Reference
Start typing to search…

Update a Domain

put
https://{server}/ns-api/v2/domains/
Path Params
string
required
length ≤ 64
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise.

Body Params
string

This is the reseller that owns this domain. Must be a valid resller name on creation. If Reseller level scope you can use "~" to set your own reseller on create, Super User's will need to set this to a valid Reseller.

string

This is a description of the domain. This will be shown in many places to help show a more user friendly version of the domain to help identify it.

string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
string
enum

Allows a special domain type to be set for specific use cases. Currently Residenital and Hospitality are options which will limit and effect the users expierence.

Allowed:
string

This is the default dial plan that will be used for new users created in the domain. A dial plan is created by default on new domain creation with a name matching the domain.

string

This is the default dial policy (permission) that will be used for new users added ot the domain. Generally these are system wide policies and will not need to create one per domain.

string

This is the email source that will be used when sending out emails for this domain. This address should be configured properly through the email server so that emails are not blocked. In most cases this is recommended to be an address on the service providers or resellers hostname so DNS SPF records can be added on the hostname to prevent spam issues. More info on SPF records available via https://www.cloudflare.com/learning/dns/dns-records/dns-spf-record/

string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
number
100 to 999

The default area code for the domain. This is used by default on 7 digit dials to extent the number to a valid 10 digit number.

string

This is the main caller id name for the user to be used for outbound calls outside of the domain.

number

This is the main caller id number for the user to be used for outbound calls outside of the domain.

number

This is the main caller id that will be used for emergency calls when placed by the user.

integer

This is the maximum number of subscribers allowed for domain including the subscribers that would be created as part of resources like call queues and auto attendants. If looking to limit nornal users it would be better to use limits-max-users

integer

This is the limit for the number of active calls allowed in the domain simultaniously. Note: this will count and limit intra domain calls.

integer

This is the limit for the number of active calls allowed in the domain simultaniously that are connected to offnet or external numbers.

integer

This is the maximum number of call queues that would be allowed to be created in this domain.

integer

This is the maximum number of auto attendants that would be allowed to be created in this domain.

integer

This is the maximum number of conference bridges that would be allowed to be created in this domain.

integer

This is the maximum number of departments that would be allowed to be created in this domain.

integer

This is the maximum number of regular users that would be allowed to be created in this domain.

integer

This is the maximum number of sites that would be allowed to be created in this domain.

integer

This is the maximum number of fax accounts that would be allowed to be created in this domain.

string
enum

The timezone which the meeting was created with

string | null

This is the SMTP server hostname. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

string | null

This is the SMTP port for sending emails. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

string | null

This is the username used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

string | null

This is the password used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.

string | null

Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling

string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
string
enum
Defaults to no

Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"

Allowed:
string
enum
Defaults to no

Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded.

Allowed:
string
Defaults to en_US

This is the language that is set for the user to be used for portal viewing.

string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
string
enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago