Skip to main content
PUT
/
api
/
tools
/
{tool_id}
{
  "webhook_url": "https://api.shop.com/v2/orders/status",
  "timeout_seconds": 45
}

{
  "success": true,
  "message": "Tool updated successfully",
  "data": {
    "tool_id": "tool_a1b2c3d4e5f6",
    "tool_name": "GetOrderStatus",
    "webhook_url": "https://api.shop.com/v2/orders/status",
    "timeout_seconds": 45,
    "updated_at": "2024-01-20T15:00:00Z"
  }
}
Update an existing tool configuration. Only provided fields will be updated.

​
Headers

​
X-API-Key
string
required
Your API key for authentication.
​
X-Organization-Id
string
required
The organization ID.
​
Content-Type
string
required
Must be application/json.

​
Path Parameters

​
tool_id
string
required
The unique identifier of the tool.

​
Permissions

  • tools:update (admin, agent_manager)

​
Request Body

All fields are optional. Only provided fields will be updated.
​
tool_name
string
New name for the tool (pattern: ^[a-zA-Z0-9_]+$, 1-50 characters).
​
tool_description
string
New description (1-500 characters).
​
webhook_url
string
New webhook URL (1-500 characters).
​
http_method
string
New HTTP method: GET, POST, PUT, PATCH, or DELETE.
​
headers
object
New headers (replaces existing).
​
parameters
array
New parameters (replaces existing).
​
timeout_seconds
integer
New timeout in seconds (1-60).

​
Response

​
success
boolean
Indicates if the update was successful.
​
message
string
Human-readable success message.
​
data
object
The updated tool object.
{
  "webhook_url": "https://api.shop.com/v2/orders/status",
  "timeout_seconds": 45
}

{
  "success": true,
  "message": "Tool updated successfully",
  "data": {
    "tool_id": "tool_a1b2c3d4e5f6",
    "tool_name": "GetOrderStatus",
    "webhook_url": "https://api.shop.com/v2/orders/status",
    "timeout_seconds": 45,
    "updated_at": "2024-01-20T15:00:00Z"
  }
}

​
Errors

​
404
object
Tool not found.
​
403
object
Tool belongs to different organization.