Skip to main content
PATCH
/
agents
/
phone-numbers
/
{id}
Update Phone Number
curl --request PATCH \
  --url https://api.cartesia.ai/agents/phone-numbers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "agent_id": "<string>"
}
'
{
  "id": "<string>",
  "number": "<string>",
  "agent": {
    "id": "<string>",
    "name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "provider": {
    "type": "twilio",
    "id": "<string>",
    "account_sid": "<string>",
    "api_key_sid": "<string>",
    "region": "us1"
  },
  "label": "<string>"
}

Authorizations

​
Authorization
string
header
required

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

Headers

​
Cartesia-Version
enum<string>
required

API version header.

Available options:
2026-03-01
Example:

"2026-03-01"

Path Parameters

​
id
string
required

The phone number ID.

Body

application/json

Fields to update on a phone number. All fields are optional. Set agent_id to null to unassign the current agent.

​
label
string

A new human-readable name.

​
agent_id
string | null

Assign an agent to answer inbound calls to this number, or null to unassign.

​
provider
object

Change the provider. Pass { "id": "..." } to reference an existing provider. The phone number must exist in the target provider's Twilio account.

Response

Phone number updated.

A phone number with its provider and agent assignment details.

​
id
string
required

Unique identifier for the phone number.

​
number
string
required

The phone number in E.164 format (e.g. +14155551234).

​
agent
object
required

The agent that answers inbound calls to this number, or null if unassigned

​
created_at
string<date-time>
required

UTC timestamp when the phone number was created.

​
updated_at
string<date-time>
required

UTC timestamp when the phone number was last updated.

​
provider
Twilio · object
required

A linked Twilio account. The api_key_sid field is partially masked in responses.

​
label
string | null

A human-readable name for the phone number.