Skip to main content
PUT
Update 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”. A phone number can route inbound calls to one assistant at a time. Before moving an assigned number, ask the user to confirm that routing to the previous assistant will be removed. Send confirm_reassignment: true and expected_inbound_workflow_id set to that previous assistant’s ID along with the new inbound_workflow_id. An unconfirmed move or an assignment that changed since it was read returns 409 Conflict without changing the number. Reload its current assignment and obtain confirmation again. Include expected_inbound_workflow_id when clearing routing as well, to avoid removing an assignment made from another page.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Path Parameters

config_id
integer
required
phone_number_id
integer
required

Body

application/json
clear_inbound_workflow
boolean
default:false
confirm_reassignment
boolean
default:false
country_code
string | null
Required string length: 2
expected_inbound_workflow_id
integer | null
extra_metadata
Extra Metadata · object | null
inbound_workflow_id
integer | null
is_active
boolean | null
label
string | null
Maximum string length: 64

Response

Successful Response

address
string
required
address_normalized
string
required
address_type
string
required
created_at
string<date-time>
required
extra_metadata
Extra Metadata · object
required
id
integer
required
is_active
boolean
required
is_default_caller_id
boolean
required
telephony_configuration_id
integer
required
updated_at
string<date-time>
required
country_code
string | null
inbound_workflow_id
integer | null
inbound_workflow_name
string | null
label
string | null
provider_sync
ProviderSyncStatus · object | null