Update Agent

Performs a full update of an AI voice agent's configuration. All required fields must be provided — fields omitted from the request body are reset to defaults.

Use PUT to:

Completely overhaul an agent's persona, prompts, and configuration in one operation.

Update the entire knowledge base by uploading a new set of files.

File handling
Any files uploaded in this request update the agent's existing knowledge base files. To keep existing files, use PATCH instead.

Constraints

The agent must be owned by the authenticated user's organization.

Up to 10 files, max 10 MB each.

Response
Returns the complete updated agent configuration.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request PUT 'https://platform-api.convirza.com/v3/ai-voice-agents/' \ --header 'Authorization: Bearer <token>' \ --form 'voiceagent_name="Sales Assistant - Updated"' \ --form 'direction="inbound"' \ --form 'org_unit_id="1001"' \ --form 'inherited_prompt_id="12"' \ --form 'integrations=""' \ --form 'integrations=""' \ --form 'created_by="2001"' \ --form 'ext_org_unit_id="1001"' \ --form 'industry_id="7"' \ --form 'voice_id="5"' \ --form 'greetings="Hi there! Thanks for calling Convirza. How may I assist you?"' \ --form 'prompt="You are an experienced and professional sales assistant. Focus on qualifying leads and scheduling demos while maintaining a friendly, helpful tone."' \ --form 'config="{ \"background_noise\": true, \"volume\": 0.9, \"block_non_intelliquent_number\": true }"' \ --form 'max_call_duration="420"' \ --form 'notification_time="45"' \ --form 'notification_message="Agent has been on the call for 45 seconds."' \ --form 'urls="https://docs.example.com/updated-guide"' \ --form 'urls="https://www.example.com/new-features"' \ --form 'knowledge_base=""' \ --form 'more_information="Updated guidelines: Always mention our new product features and promotional offers."' \ --form 'files=""'

{ "code": 200, "message": "Success", "data": { "id": 101, "primary_phone_number": "+14255551234", "prompt": "You are a professional sales assistant for Convirza. Your goal is to qualify inbound leads, answer product questions, and schedule demos. Always be concise, friendly, and focused on the caller's needs.", "greetings": "Thank you for calling Convirza! How can I assist you today?", "voiceagent_type_id": 1, "voice_id": 3, "voiceagent_name": "Sales Assistant — Inbound Leads", "type": "conversational", "voice": "alloy", "created_on": "2026-01-15T10:30:00.000Z", "updated_on": "2026-03-20T14:20:00.000Z", "status": "active", "direction": "inbound", "more_information": "Prioritize callers who mention pricing or demo requests. Escalate to a human if the caller expresses frustration.", "urls": [ "https://docs.example.com/faq", "https://www.example.com/pricing" ], "inherited_prompt_id": 12, "config": { "background_noise": false, "volume": 0.8, "block_non_intelliquent_number": true }, "max_call_duration": 300, "notification_time": 60, "notification_message": "This call will end in 1 minute.", "org_unit_id": 1001, "knowledgebase_files": [ "product-catalog.pdf", "sales-playbook.docx" ], "knowledgebase_urls": [ "https://docs.example.com/guide", "https://www.example.com/faq" ] }, "request_id": "550e8400-e29b-41d4-a716-446655440000", "timestamp": "2026-01-20T12:34:56.789Z" }

Request

Responses