Partial Update Agent

Applies a partial update to an AI voice agent, modifying only the fields present in the request. All other settings are preserved exactly as they are.

Common use cases

Update the greeting message only: { "greeting": "Hello, how can I help you today?" }

Activate or deactivate the agent: { "status": "inactive" }

Append files to the knowledge base without replacing existing ones.

File uploads
Any files uploaded via this endpoint are added to the agent's knowledge base without removing previously uploaded documents (unlike PUT, which replaces all files).

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request PATCH 'https://platform-api.convirza.com/v3/ai-voice-agents/' \ --header 'Authorization: Bearer <token>' \ --form 'voiceagent_name="Sales Assistant - Night Shift"' \ --form 'voice_id="7"' \ --form 'greetings="Good evening! Thanks for calling Convirza after hours."' \ --form 'prompt="You are a night-shift support assistant. Be concise and handle urgent inquiries efficiently."' \ --form 'config="{ \"background_noise\": false, \"volume\": 0.7 }"' \ --form 'max_call_duration="180"' \ --form 'notification_time="15"' \ --form 'notification_message="Night shift call in progress for 15 seconds."' \ --form 'urls="https://docs.example.com/night-shift-guide"' \ --form 'knowledge_base=""' \ --form 'knowledge_base=""' \ --form 'more_information="For night shift: prioritize urgent issues and escalate to on-call manager if needed."' \ --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" }

Partial Update Agent

Request

Responses