Skip to main content
PATCH
Update a custom tool

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

The custom tool id.

Required string length: 1 - 200

Body

application/json

Fields to update; only provided fields change.

Fields to update; only provided fields change.

description
string
Required string length: 1 - 1000
json_schema
object

JSON Schema for the tool's arguments (replaces).

executor_url
string<uri>
Maximum string length: 2000
executor_secret
string | null

New secret value; null clears the existing secret.

Required string length: 8 - 512
enabled
boolean
timeout_ms
integer
Required range: 1000 <= x <= 60000
confirmation
enum<string>
Available options:
never,
always
execution_mode
enum<string>

"client" tools are executed by the calling SDK and never dispatched to a webhook.

Available options:
webhook,
client

Response

The updated custom tool.

The updated custom tool.

data
object

The tool after the update (secret redacted).

meta
object