Skip to main content
PATCH
/
v1
/
update-phone-number
/
{phone_number}
curl -X PATCH "https://api.voicy.co/v1/update-phone-number/%2B15551234567" \
  -H "Authorization: Bearer voicy_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "550e8400-e29b-41d4-a716-446655440001"}'
{
  "phone_number_id": "550e8400-e29b-41d4-a716-446655440000",
  "phone_number": "+15551234567",
  "phone_number_pretty": "(555) 123-4567",
  "display_name": "Main Support Line",
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Customer Support Agent",
  "status": "active",
  "created_at": "2026-01-15T10:30:00Z"
}
Update a phone number’s configuration. Use this to assign/unassign agents or update the display name.

Path Parameters

phone_number
string
required
Phone number in E.164 format, URL-encoded. For example, +15551234567 should be encoded as %2B15551234567.

Request Body

All fields are optional - only include the fields you want to change.
agent_id
string
Agent ID to assign to this phone number. Set to null to unassign the current agent. The agent must belong to the same account as the phone number.
display_name
string
Custom display name for the phone number

Response

Returns the updated phone number object.
phone_number_id
string
Unique identifier (UUID) for internal reference
phone_number
string
Phone number in E.164 format (primary identifier)
phone_number_pretty
string
Human-readable formatted phone number
display_name
string
Custom display name for the phone number
agent_id
string
ID of the assigned agent (null if unassigned)
agent_name
string
Name of the assigned agent
status
string
Phone number status: active (agent assigned), unassigned (no agent), or suspended
created_at
string
ISO 8601 timestamp when the phone number was created
curl -X PATCH "https://api.voicy.co/v1/update-phone-number/%2B15551234567" \
  -H "Authorization: Bearer voicy_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "550e8400-e29b-41d4-a716-446655440001"}'
{
  "phone_number_id": "550e8400-e29b-41d4-a716-446655440000",
  "phone_number": "+15551234567",
  "phone_number_pretty": "(555) 123-4567",
  "display_name": "Main Support Line",
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Customer Support Agent",
  "status": "active",
  "created_at": "2026-01-15T10:30:00Z"
}