Update Phone Number
Update agent bound to a purchased phone number
Authorizations
Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"
Path Parameters
E.164 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone number APIs.
Body
Unique id of agent to bind to the number. The number will automatically use the agent when receiving inbound calls. If set to null, this number would not accept inbound call.
Unique id of agent to bind to the number. The number will automatically use the agent when conducting outbound calls. If set to null, this number would not be able to initiate outbound call without agent id override.
Nickname of the number. This is for your reference only.
Response
E.164 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone number APIs.
Last modification timestamp (milliseconds since epoch). Either the time of last update or creation if no updates available.
Pretty printed phone number, provided for your reference.
Unique id of agent to bind to the number. The number will automatically use the agent when receiving inbound calls. If null, this number would not accept inbound call.
Unique id of agent to bind to the number. The number will automatically use the agent when conducting outbound calls. If null, this number would not be able to initiate outbound call without agent id override.
Area code of the number to obtain. Format is a 3 digit integer. Currently only supports US area code.
Nickname of the number. This is for your reference only.
Was this page helpful?