--- title: "Update Integration" method: PATCH path: "/v1/integrations/{integrationId}" tags: ["Integrations"] --- # Update Integration `PATCH /v1/integrations/{integrationId}` Partially updates an existing integration by integrationId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated integration record. ## Path parameters - `integrationId` string, required ## Request body - UpdateIntegrationRequest - `name` string — Human-readable label for this integration - `description` string — Optional description of what this integration is used for ## Response `200` OK - IntegrationResponse — Represents a fully configured third-party integration. Includes its identity, authentication configuration, and available tools. Use this response to understand how to invoke external APIs via this integration. Authentication and headers are automatically applied when tools under this integration are executed. - `integrationId` string — Unique identifier for this integration. Pass this value as integrationId when executing tools, updating this integration, or managing its auth configuration. - `name` string — Human-readable name of the integration. Helps identify the connected system (e.g., Shopify store, CRM, payment provider). - `description` string — Optional explanation of what this integration is used for. Useful for agents to determine when this integration should be selected. - `authentication` IntegrationAuthResponse - `authId` string — Unique identifier for the auth record - `integrationId` string — Unique identifier of the parent integration - `authType` 'NO_AUTH' | 'BASIC_AUTH' | 'BEARER_TOKEN' | 'API_KEY' — The authentication strategy this credential set uses. Determines which credential fields are required: API_KEY — provide the apiKey object (key name, secret value, and position). BEARER_TOKEN — provide the token field. BASIC_AUTH — provide username and password fields. NO_AUTH — no credential fields required. - `headers` object — Optional list of static HTTP headers attached to every outbound request under this auth. Applied on top of any headers defined at the integration or tool level. Useful for fixed metadata headers required by the third-party API. - `createdAt` string, date-time — Timestamp when the record was created - `updatedAt` string, date-time — Timestamp when the record was last updated - `tools` IntegrationToolResponse[] — Catalog of executable operations available via this integration. Each tool represents a specific API capability (e.g., fetch order, create customer). To perform an action: inspect each tool's name and description, select the one matching the task, then invoke it using its toolId. An empty list means no tools have been configured yet. - `toolId` string — Unique identifier for this tool. Use this value as toolId when executing, updating, or deleting this tool. - `integrationId` string — Unique identifier of the integration this tool belongs to. Use this value as integrationId when making requests scoped to the parent integration. - `name` string — 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'). - `description` string — 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. - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' — 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. - `url` string — 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. - `scope` 'local' | 'community' — 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. - `headers` JsonNode — 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. - `queryParams` JsonNode — 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. - `bodyParams` JsonNode — 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. - `createdAt` string, date-time — UTC timestamp when this tool was created, in ISO 8601 format. Use for auditing or determining how long the tool has been active. - `updatedAt` string, date-time — UTC timestamp when this tool was last modified, in ISO 8601 format. Use to detect configuration changes or invalidate cached tool definitions. - `createdAt` string, date-time — Timestamp when the integration was created (in UTC). Primarily for auditing and tracking purposes. - `updatedAt` string, date-time — Timestamp when the integration was last updated (in UTC). Indicates the most recent configuration change. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/sigmamind/apis/sigmamind-apis.md) · [All operations](https://skmtc.net/sigmamind/apis/sigmamind-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sigmamind/sigmamind-apis/revisions/d00f52b5123f/schema)