Skip to main content

Save sequence draft

Replace the sequence draft configuration using the complete sequence input model. Requires an authenticated user session; saving a draft does not publish it.

PUT/api/sequences/{sequence_id}/draft
HTTP referenceScope authenticated user sessionUpdated September 27, 2026

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_idrequired

    string

    Sequence identifier.

Query parameters

  • actorUserId · optional

    string

    Optional active same-organization actor override.

Body parameters

  • namerequired

    string

    Sequence name.

  • description · optional

    string

    Sequence description.

  • exitRulesrequired

    object

    Exit behavior; see nested definition below.

  • schedulerequired

    object

    Sending window and timezone; see nested definition below.

  • steps · optional

    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 · optional

    string

    Linked source table identifier.

  • sourceTableName · optional

    string

    Source table display name.

  • emailDelivery · optional

    object

    Delivery mode and optional bulk provider configuration.

  • aiAutomationTrusted · optional

    boolean

    AI automation trust setting; defaults to false.

  • aiDraftSettings · optional

    object

    AI draft language settings.

  • enrollmentRules · optional

    object

    Enrollment skip rules.

  • flowGraph · optional

    object

    Required when actions exist, including straight-line designs. Declare version=1, exactly one entryNodeIds node, and explicit action nodes and routing edges.

  • requiredVariables · optional

    array<string>

    Variables required to render this sequence.

  • variableMap · optional

    object

    Variable-to-source mapping.

  • senderAccountIds · optional

    array<string>

    Sender account IDs.

  • senderBindings · optional

    object

    Sender assignment configuration.

  • inboxAccess · optional

    object

    Bulk manager access configuration.

  • allowHqFallback · optional

    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 · optional

    boolean

    Default signature behavior for steps.

  • voiceStyle · optional

    string

    Optional voice style guidance.

Definitions

SequenceExitRules

Each field controls whether the sequence exits after the named event.

Fields

  • stopOnBounce · optional

    boolean

  • stopOnLinkedInReply · optional

    boolean

  • stopOnManualOptOut · optional

    boolean

  • stopOnReply · optional

    boolean

SequenceSchedule

timezone is required; daily window and workday defaults are applied by the model.

Fields

  • timezonerequired

    string

  • dailyWindowStart · optional

    string

  • dailyWindowEnd · optional

    string

  • skipHolidays · optional

    boolean

  • workingDays · optional

    array<integer>

Errors

StatusMeaning
400Invalid sequence graph, including actions without flowGraph.
401An authenticated user session is required.
404Sequence not found.
422The submitted sequence configuration failed model validation.

Docs