Create site - NetSapiens API v2

Creates a site. Send its name in site, and any settings the site's users should share, such as dial-plan, caller-id-number, time-zone, or emergency-address-id.

Requires Office Manager in the domain, Reseller for a domain in your territory, or Super User. Site Manager, Basic User, Super User Read Only, and every other scope get 403.

The name is the site's key and cannot be changed later. Use letters, digits, spaces, and ., -, _, ' only. The create accepts other characters, but a site named with them cannot be read, updated, or deleted by its path. Avoid *, which scope checks read as a wildcard. The name shares the domain's extension namespace:

a name another site uses returns 409 Site already exists

a name a user or other extension uses returns 409 Extension already exists

a login already in use returns 409 Login already exists, naming the extension that holds it

The login defaults to <site>@<domain>. Set login-username to choose another. Check a name first with GET /domains/{domain}/sites/count?site=<name>.

Settings you leave out are copied from the domain's defaults. A user created later with site set copies the site's dial plan, dial policy, caller ID, time zone, area code, limits, language, and emergency address, unless the request sets them. Creating a user with a site that does not exist also creates that site.

A 202 means the site was published over the service bus (SBUS), not yet created, so a read straight after it can still return 404. With synchronous=yes, the call waits up to 2 seconds. It returns 200 with the site once the site appears, or 202 if it has not appeared yet.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢202Accepted

application/json

The site was published over the service bus and will be created on each core server. With synchronous=yes, the site did not appear within 2 seconds: read it again shortly.

Bodyapplication/json

🟠409Bad Request

🟢200OK

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//sites' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "synchronous": "no", "site": "New York" }'