Skip to main content
DELETE
Delete Condition Branch
New to condition branches? Start with List Condition Branches, which explains how a step branches and how a branch is addressed.
This deletes the branch’s whole sub-tree — its sub-sequence, its steps, and every sequence only reachable through it, however deep. It cannot be undone.
removedSequenceIds lists exactly what was deleted alongside the branch entry. A sequence another step still points at is left alone, so the list can be shorter than the sub-tree you walked, and it is empty when the branch held no steps of its own.

What is refused

The last check is run before anything is written, so a refusal leaves the step untouched.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

sequenceId
string
required

The unique identifier of the sequence holding the condition step

stepId
string
required

The unique identifier of the condition step, from GET /campaigns/{campaignId}/sequences

branchSequenceId
string
required

The branch's own sub-sequence id, from GET /sequences/{sequenceId}/steps/{stepId}/branches. A branch is never addressed by its position.

Response

The branch is gone.

ok
boolean
removedSequenceIds
string[]

The sub-tree sequences deleted with the branch. Empty when the branch held no steps of its own.