Delete user hold message

DELETE

/domains/{domain}/users/{user}/msg/{index}

Last modified:2026-10-09 00:32:59

OperationId:DeleteMsgUser

Deletes the hold message at index and its metadata. The other messages keep their indexes, so the order has a gap until you reorder or add one there.

Basic User, Advanced User, Simple User, and Call Center Agent can change their own hold messages. Site Manager can change the hold messages of users at its own site. Office Manager, Call Center Supervisor, Route Manager, Reseller, and Super User can change any user's. The read-only scopes get 403.

The file is removed on the server that handles the request, before the response, and the removal is copied to the other servers over the service bus (SBUS) file journal. The call answers 202 by default. An index with no message returns 404. Close the gap with PUT on /domains/{domain}/users/{user}/msg/reorder.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢202Accepted

application/json

The message is deleted on this server and the removal is being copied to the others.

Bodyapplication/json

🟠404

🟠400

🟠401

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//msg/1' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Deleted

The message is deleted.

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

Modified at 2026-10-09 00:32:59

Reorder user hold messages

Read user hold message