PUT
/
api
/
v1
/
organizations
/
telephony-configs
/
{config_id}
/
phone-numbers
/
{phone_number_id}
Update Phone Number
curl --request PUT \
  --url https://app.dograh.com/api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "inbound_workflow_id": 123,
  "clear_inbound_workflow": false,
  "is_active": true,
  "country_code": "<string>",
  "extra_metadata": {}
}
'
{
  "id": 123,
  "telephony_configuration_id": 123,
  "address": "<string>",
  "address_normalized": "<string>",
  "address_type": "<string>",
  "is_active": true,
  "is_default_caller_id": true,
  "extra_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "country_code": "<string>",
  "label": "<string>",
  "inbound_workflow_id": 123,
  "inbound_workflow_name": "<string>",
  "provider_sync": {
    "ok": true,
    "message": "<string>"
  }
}
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”.

Headers

​
authorization
string | null
​
X-API-Key
string | null

Path Parameters

​
config_id
integer
required
​
phone_number_id
integer
required

Body

application/json

Partial update. address is intentionally immutable — to change a number, delete the row and create a new one.

​
label
string | null
Maximum string length: 64
​
inbound_workflow_id
integer | null
​
clear_inbound_workflow
boolean
default:false
​
is_active
boolean | null
​
country_code
string | null
Required string length: 2
​
extra_metadata
Extra Metadata · object

Response

Successful Response

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

Result of pushing a phone-number change to the upstream provider.

Returned alongside create/update responses when the route attempted to sync inbound webhook configuration. ok=False is a warning, not a fatal error — the DB write succeeded.