Skip to main content
PATCH
/
v1
/
integrations
/
{integrationId}
/
tools
/
{toolId}
Update Tool
curl --request PATCH \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "get_customer_with_orders",
  "description": "Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.",
  "method": "GET",
  "endpoint": "https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json",
  "headers": [
    {
      "key": "Content-Type",
      "value": "application/json"
    }
  ],
  "queryParams": [
    {
      "key": "status",
      "value": "{{status}}"
    }
  ],
  "bodyParams": {
    "first_name": "{{firstName}}",
    "email": "{{email}}"
  }
}
'
{
  "toolId": "tool-X9pLm2Wq8Rt3",
  "integrationId": "intg-AuUKK371Spr5",
  "name": "Get Order Details",
  "description": "Fetches order details from Shopify by order ID",
  "method": "GET",
  "url": "/orders/{orderId}.json",
  "scope": "local",
  "headers": {
    "customer_name": "Michael"
  },
  "queryParams": {
    "customer_name": "Michael"
  },
  "bodyParams": {
    "customer_name": "Michael"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Path Parameters

​
integrationId
string
required

Unique identifier for the integration

​
toolId
string
required

Unique identifier for the tool

Body

application/json

Request body to partially update an existing tool. Only the fields provided will be updated — omitted fields remain unchanged. When endpoint, params, or bodyParams are updated, the tool's {{variable}} list is automatically re-extracted and refreshed.

​
name
string

Updated tool name. Should be snake_case and action-oriented. The AI agent uses this name to identify and select the correct tool.

Maximum string length: 128
Example:

"get_customer_with_orders"

​
description
string

Updated description of what this tool does and when the agent should call it. Be specific — the agent relies on this to decide whether to invoke the tool.

Maximum string length: 1024
Example:

"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed."

​
method
enum<string>

Updated HTTP method for the underlying API call. GET — retrieve. POST — create. PUT — replace. PATCH — partial update. DELETE — remove.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"GET"

​
endpoint
string

Updated full URL of the API endpoint this tool calls. Supports {{variable}} placeholders for dynamic segments. Updating this field triggers automatic re-extraction of {{variable}} placeholders.

Maximum string length: 1024
Example:

"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json"

​
headers
object[]

Replaces the complete list of static headers for this tool. Pass a non-empty list to overwrite existing headers. Pass an empty list [] to remove all headers. Omit this field entirely to leave existing headers unchanged.

Example:
[
  {
    "key": "Content-Type",
    "value": "application/json"
  }
]
​
queryParams
object[]

Replaces the complete list of query string parameters. Pass a non-empty list to overwrite existing query params. Pass an empty list [] to remove all query params. Omit this field entirely to leave existing query params unchanged. Path variables are defined directly in the endpoint URL using {{variable}} syntax — they do not need to be listed here.

Example:
[{ "key": "status", "value": "{{status}}" }]
​
bodyParams
object

Replaces the request body payload. Pass a non-empty map to overwrite the existing body. Supports {{variable}} placeholders in values. Updating bodyParams triggers automatic re-extraction of {{variable}} placeholders. Only applicable for POST, PUT, and PATCH requests.

Example:
{
  "first_name": "{{firstName}}",
  "email": "{{email}}"
}

Response

OK

​
toolId
string

Unique identifier for the tool

Example:

"tool-X9pLm2Wq8Rt3"

​
integrationId
string

Unique identifier of the parent integration

Example:

"intg-AuUKK371Spr5"

​
name
string

Human-readable name for this tool

Example:

"Get Order Details"

​
description
string

Description of what this tool does

Example:

"Fetches order details from Shopify by order ID"

​
method
string

HTTP method

Example:

"GET"

​
url
string

Relative path of the API endpoint

Example:

"/orders/{orderId}.json"

​
scope
enum<string>

Scope of the tool

Available options:
local,
community
Example:

"local"

​
headers
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
queryParams
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
bodyParams
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
createdAt
string<date-time>

Timestamp when the record was created

​
updatedAt
string<date-time>

Timestamp when the record was last updated