API ReferenceTelephony ConfigurationsPhone Numbers
Update Phone Number
Update label, inbound binding, or activation state of a phone number
Changing inbound_workflow_id re-syncs the inbound webhook with the provider; the response includes a provider_sync block with the result.
To remove an existing inbound binding, send clear_inbound_workflow: true. Sending inbound_workflow_id: null alone is treated as "no change".
Path Parameters
config_id*Config Id
phone_number_id*Phone Number Id
Header Parameters
X-API-Key?string|null
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Partial update. address is intentionally immutable — to change a
number, delete the row and create a new one.
Response Body
application/json
application/json
curl -X PUT "https://example.com/api/v1/organizations/telephony-configs/0/phone-numbers/0" \ -H "Content-Type: application/json" \ -d '{}'{ "id": 0, "telephony_configuration_id": 0, "address": "string", "address_normalized": "string", "address_type": "string", "country_code": "string", "label": "string", "inbound_workflow_id": 0, "inbound_workflow_name": "string", "is_active": true, "is_default_caller_id": true, "extra_metadata": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "provider_sync": { "ok": true, "message": "string" }}