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.",
"accessType": "local",
"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}}"
}
}
'import requests
url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}"
payload = {
"name": "get_customer_with_orders",
"description": "Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.",
"accessType": "local",
"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}}"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'get_customer_with_orders',
description: 'Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.',
accessType: 'local',
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}}'}
})
};
fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'get_customer_with_orders',
'description' => 'Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.',
'accessType' => 'local',
'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}}'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}"
payload := strings.NewReader("{\n \"name\": \"get_customer_with_orders\",\n \"description\": \"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.\",\n \"accessType\": \"local\",\n \"method\": \"GET\",\n \"endpoint\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"get_customer_with_orders\",\n \"description\": \"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.\",\n \"accessType\": \"local\",\n \"method\": \"GET\",\n \"endpoint\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"get_customer_with_orders\",\n \"description\": \"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.\",\n \"accessType\": \"local\",\n \"method\": \"GET\",\n \"endpoint\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}"
response = http.request(request)
puts response.read_body{
"toolId": "tool_X9pLm2Wq8Rt3",
"integrationId": "intg_AuUKK371Spr5",
"name": "get_order_details",
"description": "Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
"scope": "local",
"headers": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"queryParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"bodyParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"createdAt": "2024-04-20T10:00:00.000Z",
"updatedAt": "2024-04-21T08:30:00.000Z"
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/integrations/{integrationId}/tools",
"status": 400,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/tools",
"status": 401,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/tools",
"status": 403,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/tools",
"status": 404,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/tools",
"status": 500,
"timestamp": "2026-05-05T10:06:45.974Z"
}Update Tool
Partially updates an existing tool by toolId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated tool record.
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.",
"accessType": "local",
"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}}"
}
}
'import requests
url = "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}"
payload = {
"name": "get_customer_with_orders",
"description": "Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.",
"accessType": "local",
"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}}"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'get_customer_with_orders',
description: 'Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.',
accessType: 'local',
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}}'}
})
};
fetch('https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'get_customer_with_orders',
'description' => 'Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.',
'accessType' => 'local',
'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}}'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}"
payload := strings.NewReader("{\n \"name\": \"get_customer_with_orders\",\n \"description\": \"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.\",\n \"accessType\": \"local\",\n \"method\": \"GET\",\n \"endpoint\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"get_customer_with_orders\",\n \"description\": \"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.\",\n \"accessType\": \"local\",\n \"method\": \"GET\",\n \"endpoint\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmamind.ai/v1/integrations/{integrationId}/tools/{toolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"get_customer_with_orders\",\n \"description\": \"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed.\",\n \"accessType\": \"local\",\n \"method\": \"GET\",\n \"endpoint\": \"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json\",\n \"headers\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ],\n \"queryParams\": [\n {\n \"key\": \"status\",\n \"value\": \"{{status}}\"\n }\n ],\n \"bodyParams\": {\n \"first_name\": \"{{firstName}}\",\n \"email\": \"{{email}}\"\n }\n}"
response = http.request(request)
puts response.read_body{
"toolId": "tool_X9pLm2Wq8Rt3",
"integrationId": "intg_AuUKK371Spr5",
"name": "get_order_details",
"description": "Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info.",
"method": "GET",
"url": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
"scope": "local",
"headers": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"queryParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"bodyParams": {
"customer_name": "Michael",
"account_id": "ACC-001"
},
"createdAt": "2024-04-20T10:00:00.000Z",
"updatedAt": "2024-04-21T08:30:00.000Z"
}{
"error": "Bad Request",
"message": "Invalid request parameters",
"path": "/v1/integrations/{integrationId}/tools",
"status": 400,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/integrations/{integrationId}/tools",
"status": 401,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/integrations/{integrationId}/tools",
"status": 403,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/integrations/{integrationId}/tools",
"status": 404,
"timestamp": "2026-05-05T10:06:45.974Z"
}{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/integrations/{integrationId}/tools",
"status": 500,
"timestamp": "2026-05-05T10:06:45.974Z"
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Path Parameters
Unique identifier of the integration to which the tool belongs.
Unique identifier of the tool to update.
Body
Request body to partially update an existing integration tool. Only fields included in the request are updated — omitted fields remain unchanged. Updating endpoint, queryParams, or bodyParams automatically re-extracts all {{variable}} placeholders and refreshes the tool's variable list.
Replacement tool name. Must be snake_case and action-oriented. AI agents use this name to identify and select the correct tool when deciding which operation to invoke. Must remain unique within the integration. Omit to leave the existing name unchanged.
128"get_customer_with_orders"
Replacement description of what this tool does and when an agent should invoke it. Agents rely on this to match a task to the correct tool — be specific about the action, the resource it operates on, and required inputs. Omit to leave the existing description unchanged.
1024"Fetches a Shopify customer including their recent orders. Use when full customer context including purchase history is needed."
Visibility scope of this tool. 'local' means the tool is private to your account and only accessible within your integrations. 'community' means the tool is shared and discoverable by other accounts. Omit to leave the existing scope unchanged. Corresponds to the 'scope' field returned in IntegrationToolResponse.
local, community "local"
Replacement HTTP method for the underlying API call. GET retrieves a resource without side effects. POST creates a new resource. PUT fully replaces an existing resource. PATCH partially updates an existing resource. DELETE removes a resource. Omit to leave the existing method unchanged.
GET, POST, PUT, PATCH, DELETE "GET"
Replacement full URL of the API endpoint this tool calls. Supports {{variable}} placeholders for path segments the agent resolves at runtime. Updating this field automatically re-extracts all {{variable}} placeholders and refreshes the tool's variable list. Omit to leave the existing endpoint unchanged.
1024"https://my-store.myshopify.com/admin/api/2024-01/customers/{{customerId}}/orders.json"
Replacement list of static HTTP headers sent on every request by this tool. Tool-level headers are merged with integration and auth-level headers; tool-level values take precedence on key conflicts. Pass a non-empty list to overwrite all existing headers. Pass an empty list [] to remove all tool-level headers. Omit this field entirely to leave existing headers unchanged.
Show child attributes
Show child attributes
[
{
"key": "Content-Type",
"value": "application/json"
}
]
Replacement list of query string parameters appended to the URL on every invocation. Values support {{variable}} placeholders the agent resolves at runtime. Path variables embedded in the endpoint URL using {{variable}} syntax do not need to be listed here. Pass a non-empty list to overwrite all existing query params. Pass an empty list [] to remove all query params. Omit this field entirely to leave existing query params unchanged. Updating this field triggers automatic re-extraction of {{variable}} placeholders.
Show child attributes
Show child attributes
[{ "key": "status", "value": "{{status}}" }]
Replacement request body payload, as a JSON object. Values support {{variable}} placeholders the agent resolves at runtime. Pass a non-null map to overwrite the entire existing body. To remove the body entirely, pass an empty map {}. Omit this field (leave it null) to leave the existing body unchanged. Applicable only for POST, PUT, and PATCH tools — ignored for GET and DELETE. Updating this field triggers automatic re-extraction of {{variable}} placeholders.
{
"first_name": "{{firstName}}",
"email": "{{email}}"
}
Response
OK
Represents a single callable API tool registered under an integration. Each tool maps to one specific API operation (e.g., 'Get Order', 'Create Customer') and carries its full invocation config: HTTP method, endpoint URL, headers, and parameters. AI agents use this response to understand what the tool does and how to invoke it.
Unique identifier for this tool. Use this value as toolId when executing, updating, or deleting this tool.
"tool_X9pLm2Wq8Rt3"
Unique identifier of the integration this tool belongs to. Use this value as integrationId when making requests scoped to the parent integration.
"intg_AuUKK371Spr5"
Action-oriented name for this tool that identifies the operation it performs. AI agents use this name to match a task to the correct tool. Follows snake_case convention (e.g., 'get_customer', 'create_order').
"get_order_details"
Explanation of what this tool does and when an AI agent should invoke it. Agents rely on this description to decide whether this tool matches the current task. A good description names the action, the resource it operates on, and required inputs.
"Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info."
HTTP method used when invoking this tool's endpoint. GET retrieves a resource without side effects. POST creates a new resource. PUT fully replaces an existing resource. PATCH partially updates an existing resource. DELETE removes a resource.
GET, POST, PUT, PATCH, DELETE "GET"
Full URL of the API endpoint this tool calls, including any {{variable}} placeholders that the agent resolves at runtime using the declared parameters. Path segments wrapped in {{}} (e.g., {{orderId}}) are substituted before the request is sent.
"https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json"
Visibility scope of this tool. 'local' means the tool is private to your account and only accessible within your integrations. 'community' means the tool is shared and discoverable by other users.
local, community "local"
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
{
"customer_name": "Michael",
"account_id": "ACC-001"
}
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
{
"customer_name": "Michael",
"account_id": "ACC-001"
}
Dynamic key-value pairs that were passed to the agent at call start for personalisation. Keys correspond to variable names defined in the agent's configuration (e.g., 'customer_name', 'account_id'). Null or empty if no dynamic variables were provided when the call was created.
{
"customer_name": "Michael",
"account_id": "ACC-001"
}
UTC timestamp when this tool was created, in ISO 8601 format. Use for auditing or determining how long the tool has been active.
"2024-04-20T10:00:00.000Z"
UTC timestamp when this tool was last modified, in ISO 8601 format. Use to detect configuration changes or invalidate cached tool definitions.
"2024-04-21T08:30:00.000Z"