SMAO API Documentation
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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial update — include only fields you want to change. tool_key and execution_type are immutable.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/tools/65f8fa6f1a9d8e0012ab34cd" \  -H "Content-Type: application/json" \  -d '{    "display_name": "Get Current Opening Hours"  }'
{  "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": 500,      "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"  }}