Delete workflow nodes recursively
Delete a node and its downstream subtree.
dryRun: true.
If contacts are queued at any node that would be deleted, Loops returns with "status": "queuedContactsFound" instead of deleting. Retry with queuedContactPolicy: "discard" to delete the nodes and discard those queued contacts.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the workflow.
The root node ID of the subtree to delete.
Body
The workflow revision token returned by the latest workflow read or mutation. Older workflows may return null before their first revision-aware mutation; pass null back as expectedRevisionId in that case. If the token is stale, the API returns a 409 Conflict error.
If true, the request will be validated but the workflow will not be modified.
fail returns queued-contact impact instead of mutating. discard confirms that matching queued contacts should be discarded. Defaults to fail when omitted.
fail, discard Response
Delete dry run, queued-contact warning, or deletion result.
- Option 1
- Option 2
dryRun, queuedContactsFound The IDs of the nodes that would be deleted.
The number of queued contacts that would be removed from the workflow due to the node deletion.
Whether the queued contact limit would be reached if the nodes were deleted.
Related topics
Delete a workflow nodeAPI IntroductionBranching workflowsPausing workflowsEvent properties
