Lemlist: Patch Sequences Sequenceid Steps Stepid Branches Branchsequenceid

Rename a branch of a Lemlist sequence condition step or change what it tests.

Tool ID: lemlist_patch_sequences_sequenceid_steps_stepid_branches_branchsequenceid

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'lemlist_patch_sequences_sequenceid_steps_stepid_branches_branchsequenceid',
  {
    "sequenceId": "sequence_123",
    "stepId": "step_123",
    "branchSequenceId": "branch_sequence_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute lemlist_patch_sequences_sequenceid_steps_stepid_branches_branchsequenceid --input '{
  "sequenceId": "sequence_123",
  "stepId": "step_123",
  "branchSequenceId": "branch_sequence_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "sequenceId": "sequence_123",
    "index": 123,
    "fallback": true
  }
}

Use deepline describe lemlist_patch_sequences_sequenceid_steps_stepid_branches_branchsequenceid --json for the latest machine-readable contract.

Input reference

Renames a branch and/or changes what it tests. Send only the halves you want to change. The two halves are gated differently once leads have entered the campaign: a rename still goes through, while re-selecting what the branch tests is refused with 409. A body that does both on a running campaign is refused whole - the request is atomic, so the rename does not land either. Send the rename on its own if that is what you need. conditionKey is refused: every branch of a step shares the step’s condition. The Else branch is neither renamable nor editable.

Name	Type	Required	Default	Details
`payload.sequenceId`	`string`	Yes	—	The unique identifier of the sequence holding the condition step
`payload.stepId`	`string`	Yes	—	The unique identifier of the condition step, from `GET /campaigns/{campaignId}/sequences`
`payload.branchSequenceId`	`string`	Yes	—	The branch’s own sub-sequence id, from `GET /sequences/{sequenceId}/steps/{stepId}/branches`. A branch is never addressed by its position.
`payload.name`	`string`	No	—	The branch’s display name. An empty string clears it, and lemlist falls back to labelling the branch “Branch 1”, “Branch 2”, … by rank. The Else branch cannot be named.
`payload.delayType`	`"within" \| "waitUntil"`	No	—	How a lead-action condition waits: `within` branches once the `delay` window is over, `waitUntil` parks the lead until the action happens, with no time bound. Ignored by the conditions that store no time window (`customLeadInfo`, `hasEmailAddress`). Allowed: `within`, `waitUntil`.
`payload.delay`	`integer`	No	—	Length of that time window, in days.
`payload.scoreComparator`	`"$gte" \| "$lt"`	No	—	`hasScore` only - how the lead’s score is compared to `scoreThreshold`. Allowed: `$gte`, `$lt`.
`payload.scoreThreshold`	`integer`	No	—	`hasScore` only - the score this branch tests against. Minimum: 0. Maximum: 100.
`payload.emailStatusFilter`	`array`	No	—	`hasEmailAddress` only - the email statuses this branch matches. Required to add a branch on that condition. Minimum items: 1.
`payload.callStatusFilter`	`array`	No	—	`aircallDone` only - the call-status keys this branch matches. The keys are the team’s own (defaults plus custom dispositions), so any non-empty string is accepted. Required to add a branch on that condition. Minimum items: 1.
`payload.customField`	`string`	No	—	`customLeadInfo` only - the field to test. A bare name reads as a lead variable (`jobTitle` becomes `variables.jobTitle`). prefix with `fields.` to test a contact field. Every branch of a step tests the same field, so changing it here changes it on all of them.
`payload.customOperator`	`"equal" \| "contains" \| "empty" \| "notEmpty"`	No	—	`customLeadInfo` only - how the field is compared. `equal` and `contains` need a `customValue`. `empty` and `notEmpty` refuse one. Allowed: `equal`, `contains`, `empty`, `notEmpty`.
`payload.customValue`	`string`	No	—	`customLeadInfo` only - the value the field is compared to. Required for `equal` and `contains`, and refused for `empty` and `notEmpty`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	One branch of a condition step. Addressed by `sequenceId` - the sub-sequence its leads walk - never by position. The fields describing what the branch tests depend on the step’s condition. The ones that do not apply are absent.
`result.data.sequenceId`	`string`	No	—	The branch’s sub-sequence id, and its address on every branch endpoint. Pass it to `POST /sequences/{sequenceId}/steps` to add steps inside the branch.
`result.data.index`	`integer`	No	—	Execution rank among the non-fallback branches, starting at 0. The first branch whose test matches takes the lead. Absent on the Else branch, which always runs last.
`result.data.fallback`	`boolean`	No	—	`true` on the Else branch - the one that catches every lead no other branch matched. Absent on the others.
`result.data.key`	`string`	No	—	The condition the step tests. Every branch of a step shares it: a branch never carries a condition of its own.
`result.data.name`	`string`	No	—	The branch’s display name, present only when someone has set one. lemlist labels the unnamed ones “Branch 1”, “Branch 2”, … and “Else”. those defaults are not stored and are not returned here.
`result.data.delay`	`integer`	No	—	Length of the time window the condition waits on the lead’s action, in days. Only on the lead-action conditions that store one.
`result.data.delayType`	`"within" \| "waitUntil"`	No	—	How the condition waits: `within` branches once the window is over, `waitUntil` parks the lead until the action happens, with no time bound. Allowed: `within`, `waitUntil`.
`result.data.scoreComparator`	`"$gte" \| "$lt"`	No	—	`hasScore` only - how the lead’s score is compared to `scoreThreshold`. Allowed: `$gte`, `$lt`.
`result.data.scoreThreshold`	`integer`	No	—	`hasScore` only - the score this branch tests against.
`result.data.emailStatusFilter`	`array`	No	—	`hasEmailAddress` only - the email statuses this branch matches.
`result.data.callStatusFilter`	`array`	No	—	`aircallDone` only - the call-status keys this branch matches.
`result.data.customField`	`string`	No	—	`customLeadInfo` only - the tested field, normalized: a lead variable reads back as `variables.` , a contact field as `fields.` . Every branch of the step tests the same field.
`result.data.customOperator`	`"equal" \| "contains" \| "empty" \| "notEmpty"`	No	—	`customLeadInfo` only - how the field is compared to the tested values. Allowed: `equal`, `contains`, `empty`, `notEmpty`.
`result.data.customValues`	`array`	No	—	`customLeadInfo` only - every value this branch tests. The branch matches when any of them does. Empty for the `empty` and `notEmpty` operators.
`result.data.selector`	`string`	No	—	The raw stored condition selector, as JSON. Returned only when none of the fields above could describe the branch.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation