Disconnect

[POST] .../v1/connectedintegration/disconnect

Disconnects an integration. Use this destructive workflow method to remove a replicated connected integration from the account when the integration should no longer be used by REGOS. The method clears REGOS references that point to the connected integration, notifies the external integration service, disconnects the external token and returns a standard OkResult with no payload on success. The request body is required and must provide either connected_integration_id or the deprecated key; connected_integration_id takes priority when both fields are sent. The current request user must have permission to manage other users' public integrations; missing body, missing identifier, more than one match by deprecated key, unresolved integration, external disconnect failure, notification failure and database failures are returned as HTTP 200 ErrorResult business errors. The typical workflow is ConnectedIntegration/Get, then ConnectedIntegration/Disconnect for the selected connected_integration_id.

Request Parameters

Name Type Required Description
connected_integration_id String Optional Connected integration ID. Takes priority over key when both fields are passed.

Request Example

{
  "connected_integration_id": "c98210addc4f4e1bb50b17a8c1299a37"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.

Response Example

{
  "ok": true,
  "result": null
}