Update an integration connection
Changes a connection's label, enabled state, auth kind, external account, or manifest, and reseals a replacement secret when one is supplied; omitted fields are left unchanged and no credential value is echoed back. Requires the `integrations:write` workspace permission. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/workspaces/string/integrations/connections/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "string", "workspaceId": "string", "provider": "string", "key": "string", "label": "string", "enabled": true, "authKind": "api_key", "hasSecret": true, "externalAccountId": "string", "health": "unknown", "consecutiveFailures": 0, "lastSuccessfulSyncAt": "string", "lastFailureAt": "string", "lastError": "string", "nextSyncAt": "string", "manifest": {}, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Read one integration connection
Returns the summary for a single provider connection. Requires the `integrations:read` workspace permission; an unknown connection is reported as not found and stored credentials are not included.
Delete an integration connection
Removes the connection and its stored credentials, returning the deleted id. Requires the `integrations:write` workspace permission; use the disconnect preview first to see what depends on it. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.