Hold call

PATCH

/domains/{domain}/users/{user}/calls/{callid}/hold

Last modified:2026-10-30 21:09:22

OperationId:HoldCallForUser

Puts the other party on the user's call on hold. Requires Basic User scope for your own user, Office Manager for a user in your own domain, Site Manager for a user in your own site, or Reseller or Super User scope. To resume, use Resume held call.

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 command was accepted and is applied shortly after. When the user placed the call, the receiver is held; when the user received it, the caller is held.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//calls/k3m9xq2wz7pd4rtv/hold' \
--header 'Authorization: Bearer <token>'

Response Example

202 - Accepted

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

Modified at 2026-10-30 21:09:22

Answer call

Resume held call