Create a Domain From Template

Creates a new domain by cloning an existing template domain.

This is POST /domains with domain-template-source supplied — that one field switches the ordinary create into provisioning mode. Everything the standard create does still happens (the domain subscriber, the domain-named dial plan chained to the system table, reseller defaults); the template's configuration is then cloned on top.

What is cloned: dial plans and dial rules (with every reference to the template domain rewritten to the new one), UI configurations, sites, departments, subscribers, device registrations, call queues, call parks, queue membership, per-user answer rules, conferences, timeframes (including day-of-week and holiday rules), auto attendants with their full menu tree, audio (music on hold and greetings), shared contacts, and phone templates.

Device registrations clone their intent, not their state. A cloned device keeps how it authenticates, what it is allowed to do and its call-processing rule, and gets a NEW authentication key — the template's credentials are never copied. Anything describing a live registration (contact URI, source IP, user agent, latency, geo, registration times) is dropped: it describes a phone registered to the template.

What is not cloned, by design: phone numbers other than main-number, SMS numbers, and E911 addresses, which are per-location.

Shaping the result. For each resource pass either a *-list (explicit items) or a *-count (the first N from the template), or neither to clone every one the template has. A *-list entry is merged over the template item at the same index, so [{"first_name":"Jane"}] takes template user 1 and overrides its name. With user-count, extensions are assigned sequentially from the greater of the template's lowest extension and 1000, and everything that references an extension — queue membership, answer-rule destinations, the main number — is remapped to match.

Variables. Any {{TOKEN}} in the template is replaced by the matching entry in template-variables. Call GET /domains/{domain}/template-variables to discover which tokens a template carries.

Scope. A Reseller may only provision from a template in its own territory; a Super User from any.

Timing. Provisioning is synchronous and performs many writes in one request. Allow a generous client timeout, and never retry automatically — a retry attempts a second domain create.

The response is the new domain record plus provisioned_from_template and provisioned_counts, a per-resource report of what was attempted. Read the new domain's resources to confirm what exists.

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' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "domain": "{{domain}}", "reseller": "{{reseller}}", "description": "Acme Store #1234", "domain-template-source": "franchise-1", "main-number": "5551234567", "template-variables": { "STORE_NAME": "Acme Store #1234", "STORE_NUMBER": "1234", "STORE_PHONE": "5551234567" }, "user-list": [ { "first_name": "Jane", "last_name": "Smith", "email_address": "jane@store1234.example" }, { "first_name": "Bob", "last_name": "Jones", "email_address": "bob@store1234.example" } ], "queue-count": 2 }'

Request

Responses