メインコンテンツへスキップ
PATCH
Update Phone Number

承認

Authorization
string
header
デフォルト:$CARTESIA_API_KEY
必須

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

ヘッダー

Cartesia-Version
enum<string>
デフォルト:2026-03-01
必須

API version header.

利用可能なオプション:
2026-03-01
:

"2026-03-01"

パスパラメータ

id
string
必須

The phone number ID.

ボディ

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.

レスポンス

Phone number updated.

A phone number with its provider and agent assignment details.

id
string
必須

Unique identifier for the phone number.

number
string
必須

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

agent
object | null
必須

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

created_at
string<date-time>
必須

UTC timestamp when the phone number was created.

updated_at
string<date-time>
必須

UTC timestamp when the phone number was last updated.

provider
Twilio · object
必須

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.