Skip to main content
PATCH
Update HTTP tool

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de caminho

httpToolPublicId
string<uuid>
obrigatório

Corpo

application/json

Body for updating an existing HTTP tool. All fields are optional; only provided fields are updated.

configuration
object

New tool-type-specific configuration object. Shape depends on the tool's toolType.

description
string

New human-readable description of what the tool does.

Maximum string length: 1000
Exemplo:

"Fetches a user's profile information from the CRM by user ID."

name
string

New stable identifier of the tool. Must contain only letters, digits, underscores and hyphens.

Maximum string length: 150
Pattern: ^[a-zA-Z0-9_-]+$
Exemplo:

"fetch-user-profile-v2"

requiresApproval
boolean

Whether invocations of this tool require human approval before execution.

Exemplo:

true

toolType
enum<string>

Tool type is immutable. Sending this field returns 400 IMMUTABLE_FIELD.

Opções disponíveis:
HTTP_REQUEST,
DATABASE_QUERY,
INTERNAL_VARIABLE,
CUSTOM_INTEGRATION,
PIPEDREAM_MCP

Resposta

OK

HTTP/DB/Custom tool owned by the workspace.

configuration
object

Tool-type-specific configuration; opaque to the public API.

createdAt
string<date-time>
createdBy
object

Creator. {publicId: null, name: "API Key"} for API-key-created tools.

description
string
name
string
publicId
string<uuid>
requiresApproval
boolean
toolType
enum<string>
Opções disponíveis:
HTTP_REQUEST,
DATABASE_QUERY,
INTERNAL_VARIABLE,
CUSTOM_INTEGRATION
updatedAt
string<date-time>