> ## Documentation Index > Fetch the complete documentation index at: https://docs.oneinbox.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update Tool ## OpenAPI ````yaml /openapi/openapi.yaml patch /v1/tools/{tool_id} openapi: 3.1.0 info: title: OneInbox API version: 1.0.0 servers: - url: https://api.oneinbox.ai description: Production server security: [] tags: - name: health - name: integrations - name: llm-models - name: tools - name: knowledge-bases - name: voices - name: webhooks - name: agents - name: phone-numbers - name: calls - name: workspace - name: usage - name: audit-events paths: /v1/tools/{tool_id}: patch: tags: - tools summary: Update Tool operationId: update_tool_v1_tools__tool_id__patch parameters: - name: tool_id in: path required: true schema: type: string format: uuid title: Tool Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ToolUpdate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ToolResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - API Key: [] components: schemas: ToolUpdate: properties: name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description url: anyOf: - type: string - type: 'null' title: Url method: anyOf: - type: string enum: - GET - POST - PUT - PATCH - DELETE - type: 'null' title: Method headers: anyOf: - additionalProperties: true type: object - type: 'null' title: Headers parameters: anyOf: - items: $ref: '#/components/schemas/ToolParameter' type: array - type: 'null' title: Parameters parameters_schema: anyOf: - additionalProperties: true type: object - type: 'null' title: Parameters Schema credential_id: anyOf: - type: string format: uuid - type: 'null' title: Credential Id run_in_background: anyOf: - type: boolean - type: 'null' title: Run In Background speak_during_execution: anyOf: - type: boolean - type: 'null' title: Speak During Execution transfer_to: anyOf: - type: string pattern: ^\+[1-9]\d{1,14}$ - type: 'null' title: Transfer To transfer_config: anyOf: - $ref: '#/components/schemas/TransferConfig' - type: 'null' extraction_schema: anyOf: - $ref: '#/components/schemas/ExtractionSchema' - type: 'null' messaging_config: anyOf: - $ref: '#/components/schemas/MessagingConfig' - type: 'null' calendar_config: anyOf: - $ref: '#/components/schemas/CalendarConfig' - type: 'null' type: object title: ToolUpdate ToolResponse: properties: id: type: string title: Id name: type: string title: Name type: type: string title: Type description: anyOf: - type: string - type: 'null' title: Description url: anyOf: - type: string - type: 'null' title: Url method: anyOf: - type: string - type: 'null' title: Method headers: additionalProperties: true type: object title: Headers parameters: items: {} type: array title: Parameters parameters_schema: anyOf: - additionalProperties: true type: object - type: 'null' title: Parameters Schema credential_id: type: string title: Credential Id transfer_to: anyOf: - type: string - type: 'null' title: Transfer To transfer_config: anyOf: - additionalProperties: true type: object - type: 'null' title: Transfer Config run_in_background: type: boolean title: Run In Background default: false speak_during_execution: type: boolean title: Speak During Execution default: false extraction_schema: anyOf: - additionalProperties: true type: object - type: 'null' title: Extraction Schema messaging_config: anyOf: - additionalProperties: true type: object - type: 'null' title: Messaging Config calendar_config: anyOf: - additionalProperties: true type: object - type: 'null' title: Calendar Config created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - name - type - description - url - method - headers - parameters - transfer_to - created_at - updated_at title: ToolResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ToolParameter: properties: name: type: string title: Name type: type: string enum: - string - number - boolean - object - array title: Type required: type: boolean title: Required default: false description: anyOf: - type: string - type: 'null' title: Description enum: anyOf: - items: type: string type: array - type: 'null' title: Enum type: object required: - name - type title: ToolParameter TransferConfig: properties: mode: type: string enum: - cold - warm title: Mode default: cold extra_instructions: anyOf: - type: string - type: 'null' title: Extra Instructions description: Extra guidance for the warm-transfer agent during the handoff. type: object title: TransferConfig description: >- transfer_call mode. Absent/`cold` => today's blind SIP REFER. `warm` uses LiveKit's WarmTransferTask (consult room, hold music, context handoff). ExtractionSchema: properties: fields: items: $ref: '#/components/schemas/ExtractionField' type: array minItems: 1 title: Fields type: object required: - fields title: ExtractionSchema MessagingConfig: properties: to: anyOf: - type: string - type: 'null' title: To subject_template: anyOf: - type: string - type: 'null' title: Subject Template body_template: anyOf: - type: string - type: 'null' title: Body Template type: object title: MessagingConfig description: |- send_sms / send_email config. `to` is the recipient (a number/email, or `{placeholder}` resolved from extracted call data). `body_template` / `subject_template` render against {summary} + extracted fields. CalendarConfig: properties: event_type_id: anyOf: - type: integer - type: 'null' title: Event Type Id description: Cal.com event type id to book. duration_minutes: anyOf: - type: integer maximum: 1440 minimum: 1 - type: 'null' title: Duration Minutes timezone: anyOf: - type: string - type: 'null' title: Timezone description: IANA tz, e.g. 'America/New_York'. api_version: type: string title: Api Version description: Cal.com `cal-api-version` header. default: '2026-02-25' type: object title: CalendarConfig description: >- schedule_calendar_event config (Cal.com). The API key comes from the tool's linked `credential_id` (a `calcom` credential) — never stored here. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ExtractionField: properties: name: type: string maxLength: 64 minLength: 1 pattern: ^[A-Za-z_][A-Za-z0-9_]*$ title: Name type: type: string enum: - string - number - boolean - object - array title: Type description: anyOf: - type: string - type: 'null' title: Description required: type: boolean title: Required default: false type: object required: - name - type title: ExtractionField description: |- One field the LLM should extract from the call. Worker turns the list into a JSON-schema FunctionTool whose body POSTs back to the API. securitySchemes: API Key: type: http description: >- Your **API key** sent as a Bearer credential — `Authorization: Bearer `, where `` starts with `oi_sk_` (create one via `POST /v1/api-keys`). Although the field is labelled 'token', paste your API key here. A dashboard JWT is also accepted on this header for the same endpoints. scheme: bearer ````