Mute an active call

POST

/external/v1/mute/{callId}

Proxies a mute request to the Message API endpoint POST /calls/{callId}/mute.

Auth middleware: publicApiRouteHandler.

Request

Authorization

API Key

Add parameter in header

api_token

Example:

api_token: ********************

API Key

Add parameter in query

api_token

Example:

api_token: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Mute request accepted by upstream Message API

Body

🟠400BadRequest

🟠401Unauthorized

🔴500InternalServerError

🔴502UpstreamProxyError

Request Example

Shell

JavaScript

Java

Swift

cURL

No payloadOptional metadata payload

curl --location --request POST '/external/v1/mute/conv_01J8MJS4V4' \
--header 'api_token: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

200 - generic

{
    "status": "success",
    "action": "mute",
    "callId": "c_01J3Z6A4YJ4V"
}

Modified at 2026-03-06 05:03:20

Unmute an active call