voice_ai_patch_agent
Update an existing GoHighLevel voice AI agent's configuration, adjusting voice, language, prompt, working hours, and call end notifications.
Instructions
Patch Agent
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agentId | Yes | Unique agent identifier | |
| voiceId | No | Identifier for the speech synthesis voice from available voice options. Default: Auto generated | |
| language | No | Language code for the agent's speech and understanding. Default: "en-US" | |
| timezone | No | IANA timezone identifier affecting working hours and scheduling. Default: Location timezone | |
| agentName | No | Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}" | |
| locationId | No | Location ID Defaults to GHL_LOCATION_ID when omitted. | |
| agentPrompt | No | Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically | |
| translation | No | Language translation settings including enablement flag and target language code. Rules: (1) translation.enabled can only be true if the agent's language is not en-US; (2) when enabled, translation.language must be either the agent's language or en-US; (3) when enabled, translation.language is requi | |
| businessName | No | Name of the business this agent represents. Default: Uses location name | |
| numberPoolId | No | Identifier for the number pool managing phone number allocation. Default: null | |
| inboundNumber | No | Phone number for receiving inbound calls to this agent. Default: null | |
| patienceLevel | No | Tolerance level for caller response delays. Default: "high" | |
| welcomeMessage | No | Initial greeting spoken when the agent answers calls. Default: Auto generated | |
| maxCallDuration | No | Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes) | |
| agentWorkingHours | No | Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7) | |
| callEndWorkflowIds | No | Array of workflow IDs to trigger automatically when calls end. Default: [] | |
| sendUserIdleReminders | No | Enables automatic reminders when callers are silent. Default: true | |
| isAgentAsBackupDisabled | No | Prevents this agent from being used as a fallback option. Default: false (Available as backup agent) | |
| sendPostCallNotificationTo | No | Configuration for post-call email notifications to various recipients. Default: [] | |
| reminderAfterIdleTimeSeconds | No | Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds |