This page documents the canonical HTTP contract for this endpoint.
Omitted steps defaults to an empty array. When actions exist, include an explicit flowGraph even for a single action or straight-line sequence; steps-only graphless writes are rejected. The graph entry and edges route execution, while steps holds action content. Omitted enrollmentRules uses product defaults. Use Create sequence for full step and flow graph guidance. Variable and source-field catalogs: sequence variables and CRM fields. A saved draft remains unpublished until Publish sequence draft.
Path parameters
sequence_idrequiredstring
Sequence identifier.
| Name | Type | Description |
|---|---|---|
| sequence_idrequired | string | Sequence identifier. |
Query parameters
actorUserId· optionalstring
Optional active same-organization actor override.
| Name | Type | Description |
|---|---|---|
| actorUserId | string | Optional active same-organization actor override. |
Body parameters
namerequiredstring
Sequence name.
description· optionalstring
Sequence description.
exitRulesrequiredobject
Exit behavior; see nested definition below.
schedulerequiredobject
Sending window and timezone; see nested definition below.
steps· optionalarray<object>
Action content catalog referenced by flowGraph; array order does not route execution. Defaults to []. See Create sequence for step fields and valid kinds.
sourceTableId· optionalstring
Linked source table identifier.
sourceTableName· optionalstring
Source table display name.
emailDelivery· optionalobject
Delivery mode and optional bulk provider configuration.
aiAutomationTrusted· optionalboolean
AI automation trust setting; defaults to false.
aiDraftSettings· optionalobject
AI draft language settings.
enrollmentRules· optionalobject
Enrollment skip rules.
flowGraph· optionalobject
Required when actions exist, including straight-line designs. Declare version=1, exactly one entryNodeIds node, and explicit action nodes and routing edges.
requiredVariables· optionalarray<string>
Variables required to render this sequence.
variableMap· optionalobject
Variable-to-source mapping.
senderAccountIds· optionalarray<string>
Sender account IDs.
senderBindings· optionalobject
Sender assignment configuration.
inboxAccess· optionalobject
Bulk manager access configuration.
allowHqFallback· optionalboolean|null
When omitted/null new sequences default to true; explicit false disables company-phone fallback. For an existing sequence, omission preserves its saved setting.
defaultAppendSignature· optionalboolean
Default signature behavior for steps.
voiceStyle· optionalstring
Optional voice style guidance.
| Name | Type | Description |
|---|---|---|
| namerequired | string | Sequence name. |
| description | string | Sequence description. |
| exitRulesrequired | object | Exit behavior; see nested definition below. |
| schedulerequired | object | Sending window and timezone; see nested definition below. |
| steps | array<object> | Action content catalog referenced by flowGraph; array order does not route execution. Defaults to []. See Create sequence for step fields and valid kinds. |
| sourceTableId | string | Linked source table identifier. |
| sourceTableName | string | Source table display name. |
| emailDelivery | object | Delivery mode and optional bulk provider configuration. |
| aiAutomationTrusted | boolean | AI automation trust setting; defaults to false. |
| aiDraftSettings | object | AI draft language settings. |
| enrollmentRules | object | Enrollment skip rules. |
| flowGraph | object | Required when actions exist, including straight-line designs. Declare version=1, exactly one entryNodeIds node, and explicit action nodes and routing edges. |
| requiredVariables | array<string> | Variables required to render this sequence. |
| variableMap | object | Variable-to-source mapping. |
| senderAccountIds | array<string> | Sender account IDs. |
| senderBindings | object | Sender assignment configuration. |
| inboxAccess | object | Bulk manager access configuration. |
| allowHqFallback | boolean|null | When omitted/null new sequences default to true; explicit false disables company-phone fallback. For an existing sequence, omission preserves its saved setting. |
| defaultAppendSignature | boolean | Default signature behavior for steps. |
| voiceStyle | string | Optional voice style guidance. |
Definitions
SequenceExitRules
Each field controls whether the sequence exits after the named event.
Fields
stopOnBounce· optionalboolean
stopOnLinkedInReply· optionalboolean
stopOnManualOptOut· optionalboolean
stopOnReply· optionalboolean
| Name | Type | Description |
|---|---|---|
| stopOnBounce | boolean | - |
| stopOnLinkedInReply | boolean | - |
| stopOnManualOptOut | boolean | - |
| stopOnReply | boolean | - |
SequenceSchedule
timezone is required; daily window and workday defaults are applied by the model.
Fields
timezonerequiredstring
dailyWindowStart· optionalstring
dailyWindowEnd· optionalstring
skipHolidays· optionalboolean
workingDays· optionalarray<integer>
| Name | Type | Description |
|---|---|---|
| timezonerequired | string | - |
| dailyWindowStart | string | - |
| dailyWindowEnd | string | - |
| skipHolidays | boolean | - |
| workingDays | array<integer> | - |
Errors
| Status | Meaning |
|---|---|
| 400 | Invalid sequence graph, including actions without flowGraph. |
| 401 | An authenticated user session is required. |
| 404 | Sequence not found. |
| 422 | The submitted sequence configuration failed model validation. |
