v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB
Phone Numbers

Update Phone Number

Update a phone number's label, agent assignment, or provider

patch/agents/phone-numbers/{id}

Path parameters

idstring required

The phone number ID.

Headers

Cartesia-Version'2026-03-01' date required
Example:2026-03-01

API version header.

Request body

labelstring

A new human-readable name.

agent_idstring nullable

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

Response

Phone number updated.

idstring required

Unique identifier for the phone number.

labelstring nullable

A human-readable name for the phone number.

numberstring required

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

created_atstring date-time required

UTC timestamp when the phone number was created.

updated_atstring date-time required

UTC timestamp when the phone number was last updated.