Update Dialout
This request updates a dialout, targeted by its secure ID.
patch | /dialouts/{dialout_sid} |
put | /dialouts/{dialout_sid} |
Sample
A sample PATCH request to update the Dialout object, targeted by its secure ID, with the values in the request body:
curl -X PATCH \
'https://api.carrierx.com/mediator/v1/dialouts/8b2423ab-5a8b-438d-8c15-b9eee5879a5d' \
-H 'Content-Type: application/json' \
--data-binary '{"delay": "1800"}' \
-u 'mediator_user_123:qwerty123'
Response
200
status code with a serialized copy of the updated Dialout object:
{
"body": {
"account_sid": "13e156f7-0d21-4ba6-9e32-c56dc2c6098f",
"attributes": {
"hide_origination_did": "true"
},
"date_created": "2025-04-09T20:43:22.000Z",
"delay": 1800,
"dialout_sid": "8b2423ab-5a8b-438d-8c15-b9eee5879a5d",
"redirect_did": "15162065337",
"stage_one_destination_did": "15162065339",
"stage_two_destination_did": "15162065338"
},
"status": 200
}
A Dialout object can be updated using either a PATCH
or PUT
request.
-
PATCH
: Updates one or more attribute values. Only the attributes specified in the request payload will be updated; all other attributes and values will remain unchanged. The dialout secure ID is passed in the query URL, and the values to be modified are passed in the request body. -
PUT
: Updates the entire Binding object. The binding secure ID is passed in the query URL, and the complete Dialout object is passed in the request body.
Note, while all fields must be present in a PUT
request, not all attributes values may be modified after initial creation.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
dialout_sid required | string | The dialout secure ID. |
Body Arguments
JSON representation of the fields and values to be updated.
Fields that can be modified are:
attributes
delay
redirect_did
stage_one_destination_did
stage_two_destination_did
For a complete list of Dialout object attributes, refer to this section.