Rename inbox

PUT

/domains/{domain}/inboxes/{extension}

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

OperationId:UpdateInboxDomain

Renames a shared or main-number inbox. inbox_name is the only field it takes; the extension, kind, and owner cannot be changed.

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. Renaming an inbox to its current name succeeds.

A user's extension returns 404: a personal inbox has no name of its own. A 202 means the change is accepted and already applied.

Requires Office Manager, Reseller, or Super User scope. A Site Manager reaches only the inboxes whose owner is a user in its own site. An inbox with no owner, or whose owner cannot be read, is out of its reach. A Site Manager gets 403 for an inbox out of its reach. Other callers 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

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

202 - Accepted

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

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

Create inbox

Delete inbox