Skip to main content
PATCH
/
api
/
phone-numbers
/
{phoneNumber}
cURL
curl --request PATCH \
  --url http://localhost:8080/api/phone-numbers/{phoneNumber} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '
{
  "nickname": "Updated Customer Service Line",
  "inbound_agent_id": "agent_new123",
  "outbound_agent_id": "agent_new789",
  "inbound_agent_version": 2,
  "outbound_agent_version": 2,
  "inbound_webhook_url": "https://example.com/new-webhook",
  "number_provider": "plivo",
  "outbound_trunk_id": "ST_sFAXh5zmGwU2"
}
'
{
  "message": "Phone number updated successfully",
  "status": "success",
  "error": null,
  "data": {
    "phone_number": "+14157774444",
    "organization_id": "org_123",
    "phone_number_pretty": "+1 (415) 777-4444",
    "area_code": 415,
    "nickname": "Updated Customer Service Line",
    "phone_number_type": "zudu-twilio",
    "inbound_agent_id": "agent_new123",
    "outbound_agent_id": "agent_new789",
    "inbound_agent_version": 2,
    "outbound_agent_version": 2,
    "inbound_webhook_url": "https://example.com/new-webhook",
    "number_provider": "plivo",
    "outbound_trunk_id": "ST_sFAXh5zmGwU2",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T12:45:00Z",
    "last_modification_timestamp": 1703421900000
  }
}

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Path Parameters

phoneNumber
string
required

Body

application/json
nickname
string
inbound_agent_id
string
outbound_agent_id
string
inbound_agent_version
integer
outbound_agent_version
integer
inbound_webhook_url
string
number_provider
string
outbound_trunk_id
string

Response

200 - application/json

Phone number updated successfully

message
string
status
string
error
string | null
data
object