agents

Update an agent

put/api/v1/agents/{id}

Request

  • Base URL: https://www.callagent.pro
  • URL: https://www.callagent.pro/api/v1/agents/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

idinteger required
namestring required
agent_type'prompt' | 'flow' required
detect_caller_bioboolean required

Let the agent look the caller up and greet them with what it finds

owner_idinteger required

Account member who owns this agent

owner_namestring required
is_ownboolean required

True when the key's user owns it; false for an agent shared by a colleague

knowledge_base_labelstring nullable required

Display name of knowledge_base_id

shapestring required

Avatar shape for the dashboard tile

promptstring required
greeting_messagestring required
company_informationstring required
primary_language_idinteger required
default_voice_idinteger required
llm_server_idinteger required
asr_model_idinteger required
knowledge_base_idinteger nullable required
status'active' | 'paused' required
max_call_durationinteger required

SECONDS, not minutes; 60-7200

forwarding_numberstring nullable required
temperaturenumber required
speech_speednumber required
vad_activation_thresholdnumber required
vad_min_silence_durationnumber required
phrase_pause_msinteger required
max_waiting_timeinteger required

seconds

answer_delayinteger required

seconds

enable_recordingboolean required
enable_call_forwardingboolean required
enable_retryboolean required
tts_tagsboolean required

Let the model write [emotion] tags; engines that do not read them strip them

email_notificationsboolean required
notification_emailstring email nullable required
webhook_urlstring uri nullable required

Post-call webhook THIS account calls after every completed call — see the WebhookPayload schema for exactly what's POSTed to it. Not an endpoint served here.

toolsstring nullable required

NOT an OpenAI function-calling / JSON schema list — a comma-separated string of built-in capability names this agent may use, e.g. "cal,email,notes" or "secretary". Recognised names: cal (check_availability, book_appointment), sms (send_sms), email (send_email), notes (save_note, recall_notes, recall_conversation), secretary (a bundle: contacts, calendar, scheduled calls, do-not-call, notes, email, and general lookups — everything a phone secretary needs). Omit or leave empty for a plain conversational agent with no tool access.

Response

OK

idinteger required
namestring required
agent_type'prompt' | 'flow' required
detect_caller_bioboolean required

Let the agent look the caller up and greet them with what it finds

owner_idinteger required

Account member who owns this agent

owner_namestring required
is_ownboolean required

True when the key's user owns it; false for an agent shared by a colleague

knowledge_base_labelstring nullable required

Display name of knowledge_base_id

shapestring required

Avatar shape for the dashboard tile

promptstring required
greeting_messagestring required
company_informationstring required
primary_language_idinteger required
default_voice_idinteger required
llm_server_idinteger required
asr_model_idinteger required
knowledge_base_idinteger nullable required
status'active' | 'paused' required
max_call_durationinteger required

SECONDS, not minutes; 60-7200

forwarding_numberstring nullable required
temperaturenumber required
speech_speednumber required
vad_activation_thresholdnumber required
vad_min_silence_durationnumber required
phrase_pause_msinteger required
max_waiting_timeinteger required

seconds

answer_delayinteger required

seconds

enable_recordingboolean required
enable_call_forwardingboolean required
enable_retryboolean required
tts_tagsboolean required

Let the model write [emotion] tags; engines that do not read them strip them

email_notificationsboolean required
notification_emailstring email nullable required
webhook_urlstring uri nullable required

Post-call webhook THIS account calls after every completed call — see the WebhookPayload schema for exactly what's POSTed to it. Not an endpoint served here.

toolsstring nullable required

NOT an OpenAI function-calling / JSON schema list — a comma-separated string of built-in capability names this agent may use, e.g. "cal,email,notes" or "secretary". Recognised names: cal (check_availability, book_appointment), sms (send_sms), email (send_email), notes (save_note, recall_notes, recall_conversation), secretary (a bundle: contacts, calendar, scheduled calls, do-not-call, notes, email, and general lookups — everything a phone secretary needs). Omit or leave empty for a plain conversational agent with no tool access.

Changes

No recorded changes to this operation across all 1 revision of this API.