Update DID Line Information

This request updates a DID line information, targeted by the DID secure ID.

patch	/phonenumber/dids/{did_sid}/line_information
put	/phonenumber/dids/{did_sid}/line_information

Sample

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

curl -X PATCH \
'https://api.carrierx.com/core/v2/phonenumber/dids/0493d917-e23c-41db-8067-0c986df71007/line_information' \
-H 'Content-Type: application/json' \
--data-binary '{"caller_name": "J Smith"}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the updated DID Line Information object:

{
    "caller_name": "J Smith",
    "class_of_service": "business",
    "enabled": true,
    "extended_business_name": "J Smith Carpenter",
    "extended_first_name": "John",
    "extended_last_name": "Smith",
    "privacy": "public",
    "screening": "allow_all"
}

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

• A PATCH request can be used to update one or more attribute values. When using a PATCH request, only the attributes specified in the request payload will be updated, all other attributes and values will remain the same. The DID line information 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 Line Information object. The DID line information secure ID is passed in the query URL, and the entire DID Line Information object is passed in the request body.

note

Note, while all the fields must be present in a PUT request, not all the attribute values may be modified after the initial creation, because when created, some of them become read-only.

Required Scopes

To update a DID Line Information object, the partner must have the following scope enabled:

• phonenumber.line_information.manage

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.

All fields can be updated.

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