Skip to navigation
Tools

Update Tool

Updates the specified fields of the tool identified by its ID.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the tool.

Request

This endpoint expects an object.
apiRequestobjectRequired
Fields used to update an API Request Tool, including its URL, HTTP method, authentication, request data, and response handling.
OR
dtmfobjectRequired
Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior.
OR
endCallobjectRequired

Fields used to update an end-call tool, including its spoken messages and rejection plan.

OR
functionobjectRequired
Fields used to update a custom function tool, including its function definition, server, parameters, messages, and execution behavior.
OR
knowledgeBaseobjectRequired
OR
transferCallobjectRequired

Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan.

OR
handoffobjectRequired
Fields used to update a handoff tool, including its destinations, function definition, default result, messages, and rejection plan.
OR
bashobjectRequired
Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan.
OR
computerobjectRequired
Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and rejection plan.
OR
textEditorobjectRequired

Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection plan.

OR
queryobjectRequired
Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan.
OR
google.calendar.event.createobjectRequired

Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan.

OR
google.sheets.row.appendobjectRequired

Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan.

OR
google.calendar.availability.checkobjectRequired
Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan.
OR
slack.message.sendobjectRequired
Fields used to update a Slack message tool, including its spoken messages and rejection plan.
OR
smsobjectRequired
Fields used to update an SMS tool, including its spoken messages and rejection plan.
OR
mcpobjectRequired
Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection plan.
OR
gohighlevel.calendar.availability.checkobjectRequired

Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan.

OR
gohighlevel.calendar.event.createobjectRequired

Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan.

OR
gohighlevel.contact.createobjectRequired

Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan.

OR
gohighlevel.contact.getobjectRequired

Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan.

OR
sipRequestobjectRequired

Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection plan.

OR
voicemailobjectRequired

Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan.

OR
codeobjectRequired

Response

apiRequestobject
A reusable tool that sends HTTP requests to an API and supports authentication and response variable extraction.
OR
codeobject
A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout.
OR
dtmfobject
A reusable tool that lets an assistant send DTMF keypad tones during a call.
OR
endCallobject
A reusable tool that lets an assistant end the active call.
OR
functionobject

A reusable custom function tool that sends model-generated arguments to a configured server and returns the result to the assistant.

OR
knowledgeBaseobject
OR
transferCallobject
A reusable tool that transfers the active call to one of its configured destinations.
OR
handoffobject
A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination.
OR
bashobject
A reusable tool that executes shell commands in a configured environment.
OR
computerobject
A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard actions.
OR
textEditorobject
A reusable tool that reads and edits text files in a configured environment.
OR
queryobject
A reusable tool that searches configured knowledge bases and returns relevant content to the assistant.
OR
google.calendar.event.createobject
A reusable tool that adds events to a connected Google Calendar.
OR
google.sheets.row.appendobject
A reusable tool that appends rows to a connected Google Sheet.
OR
google.calendar.availability.checkobject
A reusable tool that checks availability in a connected Google Calendar.
OR
slack.message.sendobject
A reusable tool that lets an assistant send a message to Slack.
OR
smsobject
A reusable tool that lets an assistant send an SMS message during a call.
OR
mcpobject
A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools.
OR
gohighlevel.calendar.availability.checkobject
A reusable tool that checks calendar availability in a connected GoHighLevel account.
OR
gohighlevel.calendar.event.createobject
A reusable tool that adds calendar events to a connected GoHighLevel account.
OR
gohighlevel.contact.createobject
A reusable tool that adds contacts to a connected GoHighLevel account.
OR
gohighlevel.contact.getobject
A reusable tool that retrieves contacts from a connected GoHighLevel account.
OR
sipRequestobject

A reusable tool that sends SIP INFO, MESSAGE, or NOTIFY requests with configured headers and body.

OR
voicemailobject

A reusable voicemail-detection tool with optional beep detection for supported calls.

OR
ghlobject

Errors

409
Conflict Error