Create inbox

POST

/domains/{domain}/inboxes

Last modified:2026-10-09 00:56:19

OperationId:CreateInboxDomain

Creates a shared or main-number inbox with its own extension. The owner of a shared inbox becomes its first member. The extension then belongs to the inbox: it is hidden from the directory and cannot be given to a user until the inbox is deleted.

inbox_kind is one of these values:

shared: an inbox you create, with its own extension, one owner, and the members you add.

main_number: an inbox you create, with its own extension and no owner.

personal: the inbox every user already has, holding their SMS conversations across all their phone numbers (DIDs). It is addressed by the user's own extension and is never created or deleted here.

owner names the owner of a shared inbox, as an extension in the domain or <extension>@<domain>. It defaults to you. It is required when your token is not in {domain}, because the owner must be a user of the inbox's own domain, and it cannot be changed later. It must be a user, not a call queue, conference, or another inbox. A main_number inbox has no owner: sending owner returns 400.

inbox_name is split at its first space into a first and last name. A one-word name gets Inbox appended, so Support is stored and returned as Support Inbox. Names are unique in the domain, compared after that split: a name already in use returns 409. An extension already in use returns 409.

A Site Manager can create only a shared inbox whose owner, named or defaulted to you, is a user in its own site. Any other owner, or a main_number inbox, returns 403. A 202 means the change is accepted and already applied.

Requires Office Manager, Reseller, or Super User scope, or Site Manager scope as above. Other scopes get 403.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted

application/json

The change is accepted and already applied.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

cURL

Shared inboxMain-number inboxOwned by you

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//inboxes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "inbox_name": "Support Line",
    "extension": "5000",
    "inbox_kind": "shared",
    "owner": "1001"
}'

Response Example

202 - Accepted

{
    "code": 202,
    "message": "Accepted"
}

Modified at 2026-10-09 00:56:19

List user inboxes

Rename inbox