Skip to main content
PATCH
Update custom tool

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Custom tool sid (in_tl_...).

Required string length: 18
Pattern: ^in_tl_

Body

application/json

Request body of update_custom_tool.

name
string

New name, 1..255 chars.

Required string length: 1 - 255
description
string | null

New description; null clears it.

Maximum string length: 2000
provider_connection_sid
string | null

A provider connection of provider custom this tool authenticates with (in_cn_...); null = a public API, no auth injected.

Required string length: 18
Pattern: ^in_cn_
request
object

Replaces the whole template.

input_schema
object[]

Replaces the whole input list.

Maximum array length: 30
output_mapping
object

Replaces the whole mapping.

status
enum<string>

on | off.

Available options:
on,
off

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.