Update DID
This request updates a DID, targeted by its ID.
put | /dids/{id} |
Sample Request
A sample PUT request to update a DID object, targeted by its ID, with the values in the request body:
curl -X PUT \
'https://api.carrierx.com/conference/v1/dids/220' \
-H 'Content-Type: application/json' \
--data-binary '{"description":"DID new description"}' \
-u '[your_user_name]:[your_password]'
Sample Response
200
status code with a serialized copy of the updated DID object:
{
"attributes": [],
"countryCode": "US",
"description": "DID new description",
"didGroupId": 219,
"id": 220,
"phoneNumber": "15162065319",
"state": -1
}
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 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 ID. |
Body Arguments
JSON representation of the fields and values to be updated.
Fields that can be modified are:
attributes
description
didGroupId
phoneNumber
Refer to this table to view all fields that appear in the DID object.