Remove a destination and stop its syncs
Removes a destination. Ziplined clears its connection settings and stops every sync that sends to it. It also cancels anything still queued for it. What it already delivered stays in the history. The first call removes nothing. It returns a summary that names the syncs that would stop, and a confirm_id. It removes the destination when you call again with the same arguments plus confirm_id.
Use when: The user no longer wants anything sent to this webhook, email list or Slack channel.
Do not use for: Pausing one sync while the destination stays (use save_sync with enabled false instead).
Example: {"destination":"#leads"}
DELETE
Remove a destination and stop its syncs
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.
Required string length:
1 - 255Example:
"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
Path Parameters
The destination, by name or id from list_destinations.
Required string length:
1 - 200Query Parameters
The confirm_id of a needs_confirmation answer: commits what that answer summarised.
Response
The result, or without confirm_id first a needs_confirmation answer: nothing happened yet.