Update built-in tool

PUT

ai-agents

{ai_agent_id}

builtin-tools

{tool_id}

{
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>",
  "tool_description": "<string>",
  "tool_name": "send_email",
  "from_email": "<string>",
  "app_password": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Path Parameters

ai_agent_id

string

required

tool_id

string

required

Body

application/json

tool_id

string

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Updated description of the email tool

tool_name

string

default:send_email

Identifier for the email tool type, must be 'send_email'

Allowed value: "send_email"

from_email

string | null

Updated email address for the sender

app_password

string | null

Updated application-specific password

tool_id

string

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Updated description of the email tool

tool_name

string

default:send_email

Identifier for the email tool type, must be 'send_email'

Allowed value: "send_email"

from_email

string | null

Updated email address for the sender

app_password

string | null

Updated application-specific password

tool_id

string

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Updated description of the call transfer tool

tool_name

string

default:transfer_call

Identifier for the call transfer tool type

Allowed value: "transfer_call"

transfer_to

string | null

Updated phone number or identifier for call transfers

transfer_type

enum<string> | null

Updated transfer type (cold or warm)

Available options:

cold_transfer,

warm_transfer

display_phone_number

boolean | null

Updated setting for phone number display

tool_id

string

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Updated description of the calendar booking tool

tool_name

string

default:book_calendar

Identifier for the calendar booking tool type

Allowed value: "book_calendar"

event_type_id

string | null

Updated event type identifier

cal_api_key

string | null

Updated API key for calendar service

timezone

string | null

Updated timezone for calendar bookings

tool_id

string

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Updated description of the calendar availability tool

tool_name

string

default:check_calendar_availability

Identifier for the calendar availability checking tool type

Allowed value: "check_calendar_availability"

event_type_id

string | null

Updated event type identifier

cal_api_key

string | null

Updated API key for calendar service

timezone

string | null

Updated timezone for availability checks

Response

200

application/json

Successful Response

from_email

string

required

Email address configured as sender

app_password

string

required

Application-specific password used for authentication

created_at

string

required

Timestamp when the tool was created

updated_at

string

required

Timestamp when the tool was last updated

tool_id

string

Unique identifier of the email tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Description of the email tool's purpose and configuration

tool_name

string

default:send_email

Identifier for the email tool type

Allowed value: "send_email"

from_email

string

required

Email address configured as sender

app_password

string

required

Application-specific password used for authentication

created_at

string

required

Timestamp when the tool was created

updated_at

string

required

Timestamp when the tool was last updated

tool_id

string

Unique identifier of the email tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Description of the email tool's purpose and configuration

tool_name

string

default:send_email

Identifier for the email tool type

Allowed value: "send_email"

transfer_to

string

required

Configured destination for call transfers

transfer_type

enum<string>

required

Configured transfer type (cold or warm)

Available options:

cold_transfer,

warm_transfer

display_phone_number

boolean

required

Whether phone number display is enabled

created_at

string

required

Timestamp when the tool was created

updated_at

string

required

Timestamp when the tool was last updated

tool_id

string

Unique identifier of the call transfer tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Description of the call transfer tool's purpose and configuration

tool_name

string

default:transfer_call

Identifier for the call transfer tool type

Allowed value: "transfer_call"

event_type_id

string

required

Configured event type identifier

cal_api_key

string

required

API key used for calendar service authentication

created_at

string

required

Timestamp when the tool was created

updated_at

string

required

Timestamp when the tool was last updated

tool_id

string

Unique identifier of the calendar booking tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Description of the calendar booking tool's purpose and configuration

tool_name

string

default:book_calendar

Identifier for the calendar booking tool type

Allowed value: "book_calendar"

timezone

string | null

Configured timezone for calendar operations

event_type_id

string

required

Configured event type identifier

cal_api_key

string

required

API key used for calendar service authentication

created_at

string

required

Timestamp when the tool was created

updated_at

string

required

Timestamp when the tool was last updated

tool_id

string

Unique identifier of the calendar availability tool

tool_start_message

string | null

Optional message to display when the tool is started

tool_delayed_message

string | null

Optional message to display when the tool is delayed

tool_complete_message

string | null

Optional message to display when the tool is completed

tool_failed_message

string | null

Optional message to display when the tool fails

tool_description

string | null

Optional description of the tool's purpose and functionality

tool_name

string

default:check_calendar_availability

Identifier for the calendar availability checking tool type

Allowed value: "check_calendar_availability"

timezone

string | null

Configured timezone for availability operations

Get built-in tool Delete built-in tool

{
  "tool_id": "<string>",
  "tool_start_message": "<string>",
  "tool_delayed_message": "<string>",
  "tool_complete_message": "<string>",
  "tool_failed_message": "<string>",
  "tool_description": "<string>",
  "tool_name": "send_email",
  "from_email": "<string>",
  "app_password": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

API Reference

AI Agents v2

Built-in Tools

Custom Tools

Calls

Post-call Analysis

Phone Numbers

Knowledge Bases

Knowledge Bases v2

Prompt Generation

Public Sharing

API Keys

Path Parameters

Body

Response