Create a Domain Template

POST

/domains

Last modified:2026-08-16 15:38:40

OperationId:CreateDomainTemplate

Creates a domain and flags it as a template, i.e. a provisioning source other domains can be built from.

This is the ordinary domain create with domain-is-template=yes. The domain is otherwise normal — it can hold users, queues, attendants and audio like any other, and what it holds is exactly what a domain provisioned from it receives.

Who may do this. Only a Super User, or a Reseller acting inside its own territory. The check applies to create as well as update, so the flag cannot be set at create time to get around it.

Templates are hidden from ordinary domain lists. GET /domains excludes them unless asked (include-templates=yes or only), so they do not pad an administrator's domain grid or its counts. A request naming a single domain still reads it.

Making it useful. Put {{TOKEN}} placeholders in names and descriptions where each provisioned domain should differ — {{STORE_NAME}}, {{STORE_NUMBER}} — then GET /domains/{domain}/template-variables will discover them and a caller can supply values at provisioning time. Set TEMPLATE_MAIN_DEST_TYPE and TEMPLATE_MAIN_DEST_NAME in the template's UI configuration to say where a provisioned domain's main number should land.

See GET /domains/templates for the catalog of templates and what each one holds.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

Bodyapplication/json

🟠409Domain Already Exists

🟢200OK

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "franchise-1",
    "reseller": "{{reseller}}",
    "description": "Franchise store template",
    "domain-is-template": "yes",
    "caller-id-name": "{{STORE_NAME}}",
    "area-code": "619"
}'

Response Example

202 - Example 1

{
    "code": 0,
    "message": "string",
    "warnings": [
        "string"
    ]
}

Modified at 2026-08-16 15:38:40

List domain event subscription summaries

Create a Domain From Template