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

Authorizations

​
Authorization
string
header
required

Your API key sent as a Bearer credential — Authorization: Bearer <api_key>, where <api_key> starts with oi_sk_ (create one via POST /v1/api-keys). Although the field is labelled 'token', paste your API key here. A dashboard JWT is also accepted on this header for the same endpoints.

Path Parameters

​
tool_id
string<uuid>
required

Body

application/json
​
name
string | null
Required string length: 1 - 255
​
description
string | null
​
url
string | null
​
method
enum<string> | null
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
headers
Headers · object
​
parameters
ToolParameter · object[] | null
​
run_in_background
boolean | null
​
speak_during_execution
boolean | null
​
transfer_to
string | null
Pattern: ^\+[1-9]\d{1,14}$
​
extraction_schema
ExtractionSchema · object
​
messaging_config
MessagingConfig · object

send_sms / send_email config. Stored verbatim — the worker stub reads it but 501s the actual send. Templating happens later when these are wired.

​
calendar_config
CalendarConfig · object

schedule_calendar_event config. Stub today; calendar provider lives in a follow-up phase.

Response

Successful Response

​
id
string
required
​
name
string
required
​
type
string
required
​
description
string | null
required
​
url
string | null
required
​
method
string | null
required
​
headers
Headers · object
required
​
parameters
any[]
required
​
transfer_to
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
run_in_background
boolean
default:false
​
speak_during_execution
boolean
default:false
​
extraction_schema
Extraction Schema · object
​
messaging_config
Messaging Config · object
​
calendar_config
Calendar Config · object