Destinations / Disconnect destination

Disconnect destination

DELETE/v1/destinations/{id}

Disconnect a connected destination from a site by removing its stored credential. Needs the destinations:disconnect scope. The response can carry notices, for example when a Google disconnect keeps the shared Google sign-in, and cleanup_pending when remote cleanup is still running.

Path parameters

string · required

The destination id, e.g. dest_meta.

Query parameters

site_id

string

The site whose connection to remove. Required for account-wide keys on multi-site accounts, otherwise 400 site_id_required.

Response fields

string

The destination id.

object

string

Always destination.

disconnected

boolean

Always true on success.

notices

array

Present when there is something to know, each with a code and message.

cleanup_pending

boolean

Present when the platform reports remote cleanup still running.

An unknown destination or site returns 404. A 502 disconnect_failed means the disconnect could not be completed; try again.

DELETE/v1/destinations/{id}

curl -X DELETE "https://app.converly.io/api/v1/destinations/dest_meta?site_id=site_29Et…" \
  -H "Authorization: Bearer sk_live_…"

200 OK

{
  "id": "dest_meta",
  "object": "destination",
  "disconnected": true
}