Skip to main content

Update Call

This request updates a call, targeted by secure ID.

patch/calls/{call_sid}

Sample Request

A sample PATCH request to update the Call object, targeted by secure ID, with the values in the request body:

curl -X PATCH \
'https://api.carrierx.com/conference/v2/calls/69057c3e-bb90-4ed3-9c53-000000000563' \
-H 'Content-Type: application/json' \
--data-binary '{"muted":"true"}' \
-u 'conference_user_123:qwerty123'

Sample Response

200 response code with a serialized copy of the updated Call object:

{
"access_code": "890671",
"account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
"call_sid": "69057c3e-bb90-4ed3-9c53-000000000563",
"codecs": "PCMU",
"date_created": "2025-06-03T14:11:55.000Z",
"date_joined": "2025-06-03T14:11:55.000Z",
"direction": "In",
"duration": 28,
"gain_level": 0,
"meeting_room_sid": "d54061ef-8a16-459c-b055-6c0c297f46af",
"meeting_sid": "aaa07454-fa93-3d2d-b7b4-c5da9f2f87fd",
"muted": true,
"name": "",
"number_dst": "\"15162065515\" <sip:15162065515@11.22.33.44>",
"number_src": "<sip:+17605692222@55.66.77.88",
"on_hold": false,
"role": "host"
}

A PATCH request can be used to update one or more Call object property values. Only the properties specified in the request payload will be updated, all other properties and values will remain the same. The call secure ID is passed in the query URL, and the values to be modified are passed in the request body.

Path Arguments

ParameterData TypeDescription
call_sid
required
stringThe call secure ID.

Body Arguments

JSON representation of the fields and values to be updated.

Fields that can be modified are:

  • muted
  • name
  • on_hold

Refer to this table to view all fields that appear in the Call object.