Update DID

This request updates a DID, targeted by secure ID.

patch	/dids/{did_sid}
put	/dids/{did_sid}

Sample Request

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

curl -X PATCH \
'https://api.carrierx.com/conference/v2/dids/022aa786-2c40-484f-9a36-2a51e84579d6' \
-H 'Content-Type: application/json' \
--data-binary '{"did_group_sid":"ea1d0f8d-4f2d-4437-a627-694a23a2d568"}' \
-u 'conference_user_123:qwerty123'

Sample Response

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

{
    "account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
    "properties": {},
    "call_flow_sid": "fb2b69b1-6998-4cdc-b04c-a267c585f767",
    "country_code": "USA",
    "did_group_sid": "ea1d0f8d-4f2d-4437-a627-694a23a2d568",
    "did_sid": "022aa786-2c40-484f-9a36-2a51e84579d6",
    "in_country_format": "(516) 206-5919",
    "international_format": "+1 516-206-5919",
    "phonenumber": "15162065919"
}

A DID 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 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 object. The DID secure ID is passed in the query URL, and the entire DID 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_sid required	string	The DID secure ID.

Body Arguments

JSON representation of the fields and values to be updated.

Fields that can be modified are:

• properties
• call_flow_sid
• did_group_sid

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