Integrations

Delete Connection

Disconnect a CRM.

Anything already synced STAYS - this removes the connection, not the records that came through it. Any sync configured against this connection stops working, so check /integrations/crm-sync/push-enabled first if a continuous sync is running.

delete/integrations/connections/{connection_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/integrations/connections/{connection_id}
  • Auth: HTTP bearer

Path parameters

connection_idstring required

Connection id.

Query parameters

provider_config_keystring required

Provider config key, e.g. hubspot or salesforce. REQUIRED: the same connection id can exist under more than one provider config, so the key is what identifies which one to remove.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataConnectionPayload required

An open envelope for a connection, a token or a migration report.

Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as "nothing went wrong".

Changes

No recorded changes to this operation across all 3 revisions of this API.