Update mid call tool

Update an existing mid call tool

Updated 30 June 2026

On this page

This endpoint allows you to update an existing mid call tool. All fields are optional - only provide the fields you want to update.

Path Parameters

idintegerrequired

The unique identifier of the tool to update

Body Parameters

For tools linked to an Automation Platform flow, the endpoint, method, and body_format fields are ignored to protect the flow connection.

namestring

Tool name — letters, numbers and underscores, starting with a letter or underscore (max 64 characters)

descriptionstring

Detailed explanation of when and how the AI should use this tool (max 255 characters)

endpointstring

Valid URL of the API endpoint to call (max 2048 characters)

methodstring

HTTP method: GET, POST, PUT, PATCH, or DELETE

body_formatstring

Request body encoding for write methods: json (default) or form

timeoutinteger

Request timeout in seconds (1-30)

headersarray

HTTP headers to send with the request (replaces existing headers)

namestringrequired

  Header name

valuestringrequired

  Header value (supports `{{variable}}` substitution)

static_fieldsarray

Fixed key/value pairs always sent with the request (replaces existing static fields)

keystringrequired

  Field key (max 64 chars)

valuestring

  Field value (max 2048 chars; supports `{{variable}}` substitution)

schemaarray

Parameters schema (replaces existing schema)

namestringrequired

  Parameter name (1-64 chars, starts with a letter or underscore)

typestringrequired

  Parameter type: `string`, `number`, `float`, or `boolean`

descriptionstringrequired

  Parameter description (3-255 chars)

requiredboolean

  Whether the AI must collect this parameter (default `false`)

Response fields

messagestring

Success message

dataobject

The updated tool object with all current values

{
  "message": "Tool updated successfully",
  "data": {
    "id": 1,
    "name": "update_customer_info",
    "description": "Use this tool to update customer information in the system.",
    "type": "http",
    "endpoint": "https://api.yourcompany.com/customers/update",
    "method": "POST",
    "body_format": "json",
    "timeout": 15,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "static_fields": [
      {
        "key": "source",
        "value": "voxlink"
      }
    ],
    "schema": [
      {
        "name": "customer_name",
        "type": "string",
        "description": "Full name of the customer",
        "required": true
      },
      {
        "name": "balance",
        "type": "float",
        "description": "Account balance as a decimal",
        "required": false
      },
      {
        "name": "newsletter_subscription",
        "type": "boolean",
        "description": "Whether customer wants to subscribe to newsletter",
        "required": false
      }
    ],
    "created_at": "2025-10-10T12:00:00.000000Z",
    "updated_at": "2025-10-10T14:30:00.000000Z"
  }
}

{
  "message": "Tool not found"
}

{
  "message": "Validation failed",
  "errors": {
    "name": ["Tool name must start with a letter or underscore and contain only letters, numbers, and underscores (max 64 characters)."]
  }
}

Managing Tool Assignments

To attach or detach this tool from assistants, use the Assistant API:

Create Assistant - Use the tool_ids parameter to attach tools when creating an assistant
Update Assistant - Use the tool_ids parameter to manage which tools are assigned to an assistant