Create domain

Creates a domain in a reseller's territory. Requires Reseller scope for that territory, or Super User scope. Send reseller as ~ to use your own territory.

With the domain, the API creates its dial plan, named by dial-plan or after the domain, with a default dial rule. It also creates the domain user domain@<domain>, which holds the defaults new users inherit: time zone, dial plan, dial permission, caller ID, area code, language, and voicemail settings. Fields you leave out take your reseller's or the platform's default values.

A 202 means the domain is accepted and created shortly after. Send synchronous=yes to wait instead: the answer is 200 with the new domain, or 202 if it is not ready within about 10 seconds.

A domain name that already exists returns 409. Setting recording-configuration requires Reseller scope or above.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains?include-secrets=no' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "domain": "example.com", "reseller": "example-reseller", "description": "Example Company", "time-zone": "US/Eastern", "area-code": 555, "caller-id-name": "Example Company", "caller-id-number": "15555550100", "dial-policy": "US and Canada", "limits-max-users": 50, "language-token": "en_US" }'

{ "domain": "acme.example.com", "reseller": "example-reseller", "description": "Acme Front Desk", "domain-type": "Standard", "dial-plan": "acme.example.com", "dial-policy": "US and Canada", "time-zone": "US/Pacific", "language-token": "en_US", "area-code": 555, "caller-id-name": "", "caller-id-number": "", "caller-id-number-emergency": "", "emergency-address-id": "", "music-on-hold-enabled": "yes", "music-on-ring-enabled": "no", "music-on-hold-randomized-enabled": "no", "voicemail-user-control-enabled": "yes", "voicemail-transcription-enabled": "no", "is-domain-locked": "no", "is-stir-enabled": "yes", "is-ivr-forward-change-blocked": "no", "single-sign-on-enabled": "yes", "user-authentication": "login_name_and_password", "allow_user_primary_email_edit": 0, "account_recovery_user_primary_email": 1, "require_unique_primary_user_email": 0, "allow_sso_with_additional_emails": 0, "email-send-from-address": "noreply@example.com", "email-send-smtp-hostname": "", "email-send-smtp-port": "", "email-send-smtp-username": "", "limits-max-subscriber-resources-total": 0, "limits-max-users": 50, "limits-max-active-calls-total": 20, "limits-max-active-calls-offnet": 10, "limits-max-call-queues": 5, "limits-max-auto-attendants": 5, "limits-max-conferences": 5, "limits-max-departments": 10, "limits-max-sites": 2, "limits-max-fax-accounts": -1, "maxCallMinute": 0, "active-calls-total-current": 0, "active-calls-against-license-count": 0, "active-calls-offnet-current": 0, "hipaa-covered": 1, "gdpr-covered": 1, "part2-covered": 0, "account-id": "", "provider-notes": "", "last-modified-datetime": "2026-09-01T14:30:00+00:00" }

Request

Responses