Update DID Group

This request updates a DID group, targeted by secure ID.

patch	/did_groups/{did_group_sid}
put	/did_groups/{did_group_sid}

Sample Request

A sample PATCH request to update a DID group by its secure ID. The request can include a JSON body with the fields and values to be updated.

curl -X PATCH \
'https://api.carrierx.com/conference/v2/did_groups/ea1d0f8d-4f2d-4437-a627-694a23a2d568' \
-H 'Content-Type: application/json' \
--data-binary '{"name":"New DID group"}' \
-u 'conference_user_123:qwerty123'

Sample Response

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

{
    "account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
    "properties": {},
    "call_flow_sid": null,
    "did_group_sid": "ea1d0f8d-4f2d-4437-a627-694a23a2d568",
    "name": "New DID group",
}

A DID Group object can be updated using either a PATCH or PUT request.

• A PATCH request can be used to update one or more property values. When using a PATCH request, only the properties specified in the request payload will be updated, all other properties and values will remain the same. The DID group secure ID is passed in the query URL, and the values to be modified are passed in the request body.

• A PUT request can be used to update an entire DID Group object. The DID group secure ID is passed in the query URL, and the entire DID Group object is passed in the request body.

note

Note, while all fields must be present in a PUT request, not all properties values may be modified after initial creation.

Path Arguments

Parameter	Data Type	Description
did_group_sid required	string	The DID group secure ID.

Body Arguments

JSON representation of the fields and values to be updated.

Fields that can be modified are:

• properties
• call_flow_sid
• name

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