Skip to Content
WalidoDocs
Public APITools

Update a tool

PATCH
/tools/{tool_id}

Partial update - only included fields are changed. tool_key and execution_type are immutable (create a new tool instead). To rotate an auth secret, submit a full auth object with the new value; the previous secret is overwritten in place. A stored credential never follows a URL change: a PATCH that changes webhook.url of a tool with a stored credential must include auth with that credential, otherwise it returns 400 and nothing changes.

A webhook object replaces the stored webhook configuration as a whole: omitted method, timeout_ms and retry_count fall back to POST, 10000 and 0, and omitted headers and body_template are removed. Send the complete webhook configuration to change one field.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the Walido dashboard (Settings → API Keys).

Path Parameters

tool_id*string
Match^[a-f0-9]{24}$

Request Body

application/json
  1. body

Partial update - include only fields you want to change. tool_key and execution_type are immutable. Changing webhook.url of a tool with a stored credential requires auth with that credential. A webhook object replaces the whole stored webhook configuration; omitted webhook fields return to their defaults or are removed.

Properties1 <= properties
display_name?string

Leading/trailing whitespace is trimmed.

Length1 <= length <= 200
description?string
Lengthlength <= 1000
parameters?
webhook?
auth?||

Auth credentials sent on POST/PATCH. Shape varies by type. Note: secret and password are write-only; responses use ToolAuthSummary.

Response Body

Updated tool.

application/json
  1. response
data?
Example Request
curl -X PATCH 'https://api.walido.it/api/v1/tools/65f8fa6f1a9d8e0012ab34cd' \  -H 'Content-Type: application/json' \  -d '{  "display_name": "Get Current Opening Hours"}'
Example Response
{  "data": {    "id": "string",    "tool_key": "string",    "display_name": "string",    "description": "string",    "parameters": {},    "execution_type": "webhook",    "source": "custom",    "webhook": {      "url": "http://example.com",      "method": "GET",      "headers": {},      "body_template": "string",      "timeout_ms": 10000,      "retry_count": 0    },    "integration": null,    "auth": {      "type": "apiKey",      "header_name": "string",      "username": "string",      "has_secret": true    },    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}