Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Integrations

Update Integration

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.

patch/v1/integrations/{integrationId}

Path parameters

integrationIdstring required

Unique identifier of the integration to update.

Request body

namestring

Human-readable label for this integration

descriptionstring

Optional description of what this integration is used for

Example request

{
  "name": "my_shopify_store",
  "description": "Handles order lookups and refunds for the support agent"
}

Response

OK

integrationIdstring

Unique identifier for this integration. Pass this value as integrationId when executing tools, updating this integration, or managing its auth configuration.

namestring

Human-readable name of the integration. Helps identify the connected system (e.g., Shopify store, CRM, payment provider).

descriptionstring

Optional explanation of what this integration is used for. Useful for agents to determine when this integration should be selected.

createdAtstring date-time

Timestamp when the integration was created (in UTC). Primarily for auditing and tracking purposes.

updatedAtstring date-time

Timestamp when the integration was last updated (in UTC). Indicates the most recent configuration change.

Example response

{
  "integrationId": "intg_AuUKK371Spr5",
  "name": "My Shopify Store",
  "description": "Handles order lookups and customer data retrieval",
  "authentication": {
    "authId": "auth_P3kNz7Yv1Qm9",
    "integrationId": "intg_AuUKK371Spr5",
    "authType": "API_KEY"
  },
  "tools": [
    {
      "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"
    }
  ],
  "createdAt": "2024-04-20T10:00:00.000Z",
  "updatedAt": "2024-04-21T08:30:00.000Z"
}