Update tool

PATCH

/api/tools/{id}

Partially updates a tool. Only the fields present in the request body are changed; omitted fields are left untouched. The agent a tool belongs to cannot be changed.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Updated tool.

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.snakk.ai/api/tools/' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "display_name": "Book appointment (v2)",
    "webhook_url": "https://example.com/webhooks/book-v2",
    "enabled": true
}'

Response Example

200 - Example 1

{
    "tool": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
        "name": "string",
        "display_name": "string",
        "description": "string",
        "type": "webhook",
        "webhook_url": "string",
        "webhook_method": "GET",
        "webhook_headers": {},
        "webhook_body_template": "string",
        "webhook_timezone": "string",
        "parameters": {},
        "transfer_destinations": [
            {}
        ],
        "enabled": true
    }
}

Modified at 2026-07-08 19:01:40

Create tool

Delete tool