Create user hold message

POST

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

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

OperationId:CreateUserHoldMessageUpload

Adds a hold message for the user, from an uploaded file, a base64 file, or text to speech. It takes the next free index unless you send index. 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.

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. Read the file with GET on the collection.

Bodyapplication/json

🟢200OK

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

🔴507Insufficient Storage

🔴500Internal Server Error

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//msg' \
--header 'Authorization: Bearer <token>' \
--form 'file=@""' \
--form 'index="3"' \
--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 stored.

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

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

Count user hold messages

Update user hold message