Skip to main content
POST
Update an inbound agent

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

phoneNumber
string
required

Body

application/json
phoneNumber
string

Phone number for the inbound agent

Example:

"+1234567890"

agentName
string

Name of the agent

Example:

"Agent Name"

task
string

Task or prompt for the agent

Example:

"Task description"

selectedVoice
string

Voice for the agent

Example:

"en-US-Standard-A"

background_track
string

Background track for the agent

Example:

"none"

noise_cancellation
boolean

Whether to enable noise cancellation

Example:

false

model
string

AI model to use

Example:

"gpt-4"

max_duration
number

Maximum duration in seconds

Example:

300

interruptionThreshold
number

Interruption threshold

Example:

1000

firstSentence
string

First sentence to say

Example:

"Hello!"

selectedLanguage
string

Language for the agent

Example:

"en"

voice_settings
object

Voice settings

Example:
waitForGreeting
boolean

Whether to wait for greeting

Example:

true

temperature
number

Temperature for AI responses

Example:

0.7

pathwayID
string

Pathway ID

Example:

"pathway-123"

tools
string[]

Tools to use

Example:
knowledgeName
string

Name of the knowledge base

Example:

"Knowledge base name"

knowledgeBases
string[]

Knowledge base data

Example:
metadata
object

Additional metadata

Example:
transferPhoneNumber
object[]

Transfer phone numbers

Example:
appointmentAgent
boolean

Whether this is an appointment agent

Example:

true

calendarID
string

Calendar ID

Example:

"cal-123"

calendarName
string

Calendar name

Example:

"My Calendar"

questionsData
object[]

Questions for the agent

Example:
customTool
string[]

Custom tools

Example:
inboundCustomTool
string[]

Custom tools

Example:
from
string

Phone number to call from

Example:

"+1234567890"

block_interruptions
boolean

Whether to block interruptions

Example:

false

keywords
string[]

Keywords to boost in transcription

Example:
pronunciationGuide
string[]

Pronunciation guide for specific words

Example:
timezone
string

Timezone for the call

Example:

"America/Los_Angeles"

request_data
object

Request data available to the AI agent during the call

Example:
start_time
string

Scheduled start time for the call

Example:

"2024-03-20 12:00:00 -05:00"

voicemail_message
string

Message to leave on voicemail

Example:

"Please leave a message after the beep"

voicemail_action
enum<string>

Action to take when voicemail is detected

Available options:
hangup,
leave_message,
ignore
Example:

"hangup"

retry
object

Retry configuration for voicemail calls

Example:
record
boolean

Whether to record the call

Example:

true

webhook_events
string[]

Events to stream to webhook

Example:
citation_schema_id
string

Citation schema ID for post-call analysis

Example:

"dcad76eb-57b6-4be6-922f-8a5a95e2ffrt"

analysis_preset
string

Analysis preset UUID

Example:

"a0f0d4ed-f5f5-4f16-b3f9-22166594d7a7"

answered_by_enabled
boolean

Whether to enable answered-by detection

Example:

true

available_tags
string[]

Available disposition tags

Example:
geospatial_dialing
string

Geospatial dialing pool UUID

Example:

"bd039087-decb-435a-a6e3-ca1ffbf89974"

precall_dtmf_sequence
string

DTMF sequence to play before call starts

Example:

"1234567890*#w"

pool_id
string

Pool ID

Example:

"#1234-5678-9012-3456"

memory_id
string

UUID of the memory to associate with this agent

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

webhook_config
object

Webhook configuration

get_data
object

Get data configuration

Response

200

Agent updated successfully