Update DID Group
This request updates a DID group, targeted by its ID.
put | /didGroups/{id} |
Sample Request
A sample PUT request to update a DID Group object, targeted by its ID, with the values in the request body:
curl -X PUT \
'https://api.carrierx.com/conference/v1/didGroups/219' \
-H 'Content-Type: application/json' \
--data-binary '{"description":"Updated DID group description"}' \
-u '[your_user_name]:[your_password]'
Sample Response
200
status code with a serialized copy of the updated DID Group object:
{
"attributes": [],
"callFlowId": 1,
"description": "Updated DID group description",
"id": 219,
"name": "Test DID group",
"state": -1,
"subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}
A PUT
request is used to update one or more attribute values. When using a PUT
request, only the attributes specified in the request payload will be updated, all other attributes and values will remain the same. The DID group ID is passed in the query URL, and the values to be modified are passed in the request body.
Path Arguments
Parameter | Data Type | Description |
---|---|---|
id required | string | The DID group ID. |
Body Arguments
JSON representation of the fields and values to be updated.
Fields that can be modified are:
attributes
callFlowId
description
name
Refer to this table to view all fields that appear in the DID Group object.