v17

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-173538121.5 KB
Tools

Update Tool

Update an existing tool. Only provided fields are updated.

patch/v1/bots/{bot_uid}/tools/{tool_id}

Path parameters

bot_uidstring required

The unique identifier of the bot.

tool_idinteger required

The numeric ID of the tool.

Request body

type'api_request' | 'function' | 'end_call' | 'transfer_call' | 'dtmf' | 'send_sms' | 'send_email' | 'call_booking' | 'check_calendar_availability' | 'check_working_hours'

The type of tool that determines its behavior and required configuration.

namestring
descriptionstring
urlstring
method'get' | 'post'
api_timeoutinteger
parametersobject
use_raw_schemaboolean
static_paramsobject
speak_during_executionboolean
speak_after_executionboolean
asyncboolean

Response

Updated tool.

idinteger

Unique numeric ID of the tool.

type'api_request' | 'function' | 'end_call' | 'transfer_call' | 'dtmf' | 'send_sms' | 'send_email' | 'call_booking' | 'check_calendar_availability' | 'check_working_hours'

The type of tool that determines its behavior and required configuration.

namestring
descriptionstring
urlstring
methodstring
api_timeoutinteger
parametersobject
use_raw_schemaboolean
static_paramsobject
speak_during_executionboolean
speak_after_executionboolean
asyncboolean
created_atstring date-time
updated_atstring date-time