Skip to main content
PATCH
/
v1
/
tools
/
{tool_id}
Update
curl --request PATCH \
  --url https://api.oneinbox.ai/v1/tools/{tool_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "method": "<string>",
  "headers": {},
  "parameters": [
    {
      "name": "<string>",
      "type": "<string>",
      "required": true,
      "description": "<string>",
      "enum": [
        "<string>"
      ]
    }
  ],
  "transfer_to": "<string>",
  "run_in_background": true,
  "speak_during_execution": true,
  "extraction_schema": {},
  "messaging_config": {
    "to": "<string>",
    "body_template": "<string>",
    "subject_template": "<string>"
  },
  "calendar_config": {
    "calendar_id": "<string>",
    "duration_minutes": 123,
    "timezone": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oneinbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use api_key from POST /v1/api-keys

Path Parameters

tool_id
string
required

Body

application/json
description
string

Response

200 - application/json

OK

id
string
name
string
type
enum<string>
Available options:
api_call,
transfer_call,
end_call,
send_sms,
send_email,
schedule_calendar_event,
extract_information
description
string
url
string | null
method
string | null
headers
object
parameters
object[] | null
transfer_to
string | null
run_in_background
boolean
speak_during_execution
boolean
extraction_schema
object
messaging_config
object
calendar_config
object
created_at
string<date-time>
updated_at
string<date-time>