---
title: "Update Custom Tool"
method: PUT
path: "/admin/tool/custom/{tool_id}"
tags: ["public"]
---

# Update Custom Tool

`PUT /admin/tool/custom/{tool_id}`

## Path parameters

- `tool_id` integer, required

## Request body

- CustomToolUpdate
  - `name` string, nullable
  - `description` string, nullable
  - `definition` object, nullable
  - `custom_headers` Header[], nullable
    - `key` string, required
    - `value` string, required
  - `passthrough_auth` boolean, nullable
  - `oauth_config_id` integer, nullable

## Response `200`

Successful Response

- ToolSnapshot
  - `id` integer, required
  - `name` string, required
  - `description` string, required
  - `definition` object, nullable, required
  - `display_name` string, required
  - `in_code_tool_id` string, nullable, required
  - `custom_headers` unknown[], nullable, required
    - unknown
  - `passthrough_auth` boolean, required
  - `mcp_server_id` integer, nullable
  - `user_id` string, nullable
  - `oauth_config_id` integer, nullable
  - `oauth_config_name` string, nullable
  - `enabled` boolean
  - `chat_selectable` boolean
  - `agent_creation_selectable` boolean
  - `default_enabled` boolean

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/onyx-dot-app/apis/onyx-api.md) · [All operations](https://skmtc.net/onyx-dot-app/apis/onyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onyx-dot-app/onyx-api/versions/027af016ba5c/schema)