Update Phone Number

Update label, inbound binding, or activation state of a phone number

1 min read

put/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}

Request example

curl --request PUT \
  --url https://voice.menaceui.com/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id} \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "<string>",
  "inbound_workflow_id": 1,
  "clear_inbound_workflow": false,
  "telephony_trunk_id": 1,
  "clear_trunk": false,
  "is_active": true,
  "country_code": "<string>",
  "extra_metadata": {}
}'

Response

{
  "id": 1,
  "telephony_configuration_id": 1,
  "address": "<string>",
  "address_normalized": "<string>",
  "address_type": "<string>",
  "country_code": "<string>",
  "label": "<string>",
  "inbound_workflow_id": 1,
  "inbound_workflow_name": "<string>",
  "telephony_trunk_id": 1,
  "is_active": true,
  "is_default_caller_id": true,
  "extra_metadata": {},
  "created_at": "2026-08-10T12:00:00Z",
  "updated_at": "2026-08-10T12:00:00Z",
  "provider_sync": {
    "ok": true,
    "message": "<string>"
  }
}

put/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}

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_idintegerrequired#

phone_number_idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

labelstring · null#

Show child attributes

Any of

inbound_workflow_idinteger · null#

Show child attributes

Any of

clear_inbound_workflowboolean#

Default: false

telephony_trunk_idinteger · null#

Show child attributes

Any of

clear_trunkboolean#

Default: false

is_activeboolean · null#

Show child attributes

Any of

country_codestring · null#

Show child attributes

Any of

extra_metadataobject · null#

Show child attributes

Any of

Responses

application/json

Successful Response

idintegerrequired#

telephony_configuration_idintegerrequired#

addressstringrequired#

address_normalizedstringrequired#

address_typestringrequired#

country_codestring · null#

Show child attributes

Any of

labelstring · null#

Show child attributes

Any of

inbound_workflow_idinteger · null#

Show child attributes

Any of

inbound_workflow_namestring · null#

Show child attributes

Any of

telephony_trunk_idinteger · null#

Show child attributes

Any of

is_activebooleanrequired#

is_default_caller_idbooleanrequired#

extra_metadataobjectrequired#

created_atstringrequired#

updated_atstringrequired#

provider_syncobject · null#

Show child attributes

Any of

okbooleanrequired#

messagestring · null#

Show child attributes

Any of

Get Phone Number Delete Phone Number