Skip to main content
PATCH
Update a phone number

Authorizations

Authorization
string
header
required

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Path Parameters

id
string<uuid>
required

The phone number uuid.

Body

application/json

Send at least one of label or agent_id.

label
string
Required string length: 1 - 80
agent_id
string<uuid> | null

An ElevenLabs-runtime agent of yours, or null to unassign.

Response

The phone number after the update.

id
string<uuid>
required
Example:

"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

phone_number
string
required
Example:

"+5215555550100"

label
string | null
required
Example:

"Main line"

provider
string
required
Example:

"twilio"

runtime
enum<string>
required

engine is the Ryvo runtime; elevenlabs is the legacy voice runtime.

Available options:
engine,
elevenlabs
Example:

"engine"

agent
object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required