Update user hold message

PUT

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

Last modified:2026-10-30 21:01:27

OperationId:UpdateMsgUserFileUpload

Replaces the audio of the hold message at index with an uploaded file or a base64 file, or changes only its description. The index does not change. Any user can change its own hold messages. Office Manager, Call Center Supervisor, Route Manager, Reseller, and Super User can change any user's in the domain, and Site Manager those of users at its own site. To replace the audio with text to speech, POST to /domains/{domain}/users/{user}/msg with the same index.

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

multipart/form-data

Required

Responses

🟢202Accepted

application/json

The change is accepted and applied shortly after. A request with neither audio nor file-script-text changes nothing and still answers 202.

Bodyapplication/json

🟠404

🟠400

🟠401

🟢200OK

🟠403Forbidden

🔴507Insufficient Storage

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//msg/1' \
--header 'Authorization: Bearer <token>' \
--form 'file=@""' \
--form 'file-script-text="Thank you for holding. Visit example.com for our current offers."' \
--form 'synchronous="yes"'

Response Example

202 - Accepted

The message is replaced.

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

Modified at 2026-10-30 21:01:27

Create user hold message

Reorder user hold messages