Skip to main content
PATCH
/
phone
/
{phone_agent_id}
Update an AI phone agent
curl --request PATCH \
  --url https://api.open.cx/phone/{phone_agent_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "inbound",
  "voice_id": "<string>",
  "language": "<string>",
  "first_message": "<string>",
  "instructions": [
    "<string>"
  ],
  "handoff_phone_number": "<string>",
  "use_org_knowledgebase": true,
  "actionIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "org_id": "<string>",
  "phone_number": "<string>",
  "name": "<string>",
  "type": "inbound",
  "language": "<string>",
  "accent": "<string>",
  "handoff_phone_number": "<string>",
  "speed": 123,
  "interruptible": true,
  "actionIds": [
    "<string>"
  ],
  "instructions": [
    "<string>"
  ],
  "data_collection_fields": [
    "<string>"
  ],
  "data_collection_webhook_url": "<string>",
  "model": "oppie-vox",
  "voice_id": "<string>",
  "first_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "provider_external_id": "<string>",
  "flow": null,
  "manual_mode": true,
  "custom_llm": "<string>",
  "use_org_knowledgebase": true
}

Path Parameters

​
phone_agent_id
string
required

Body

application/json
​
name
string

Agent display name

​
type
enum<string>

Agent type: "inbound" (receives calls, default) or "outbound" (makes calls)

Available options:
inbound,
outbound
​
voice_id
string | null

Voice ID from the /phone/voices endpoint. Omit for default voice.

​
language
string | null

Primary language code (e.g. "en", "es", "fr")

​
first_message
string | null

What the agent says when it picks up (default: "Hello?")

​
instructions
string[] | null

Training scenario IDs to attach to this agent

​
handoff_phone_number
string | null

Phone number to transfer to when handing off to a human (E.164 format)

​
use_org_knowledgebase
boolean | null

Whether the agent can search your knowledge base during calls (default: false)

​
actionIds
string[] | null

Action IDs the agent can call during conversations

Response

Default Response

​
id
string
required
​
org_id
string
required
​
phone_number
string | null
required
​
name
string | null
required
​
type
enum<string>
required
Available options:
inbound,
outbound
​
language
string | null
required
​
accent
string | null
required
​
handoff_phone_number
string | null
required
​
speed
number | null
required
​
interruptible
boolean
required
​
actionIds
string[] | null
required
​
instructions
string[] | null
required
​
data_collection_fields
string[] | null
required
​
data_collection_webhook_url
string | null
required
​
model
enum<string>
required
Available options:
oppie-vox,
oppie-vox-turbo,
oppie-vox-2,
oppie-vox-livekit
​
voice_id
string | null
required
​
first_message
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
provider_external_id
string | null
required
​
flow
unknown
required
​
manual_mode
boolean
required
​
custom_llm
string | null
required
​
use_org_knowledgebase
boolean
required