v3

latestOpenAPI 3.1.02026-07-311255771.3 MB
General

Set integration enabled

Enable or disable the specified integration. When disabling, all currently running syncs will be cancelled.

All authentication credentials and configuration are preserved. Syncs can be resumed by re-enabling the integration.

You may use this to, for example, pause syncing for customers that are temporarily not using the integration.

put/integrations/{integration_id}/enabled

Path parameters

integration_idstring required

PUT /integrations/:integration_id/enabled Parameter

Request body

valueboolean required

The desired state of the integration (e.g., true for enabled, false for disabled).

Response

PUT /integrations/:integration_id/enabled Positive response

status'success' required
dataobject required