Skip to main content

Update sequence

Update an existing sequence definition. Supports actor override with actorUserId.

PUT/api/sequences/{sequence_id}
HTTP referenceScope sequences:writeUpdated October 16, 2026

This page documents the canonical HTTP contract for this endpoint.

Send the full action catalog and explicit flowGraph for every authored design, including straight-line sequences. Exactly one entryNodeIds node and the edges determine execution; steps order does not. Steps-only graphless writes are rejected. See Create sequence for graph guidance.

The response retains the {success, sequence} envelope. A committed configuration change increments sequence.config_revision. When removed steps, schedule changes, or provider email content require follow-up work, the save durably admits that work together with the configuration under optimistic concurrency; it does not wait for every task, outbox, enrollment, or provider effect to finish.

Read sequence.config_reconciliation.operation_run_id when present and follow canonical operation-run progress. Its job_id is the separate native job identity; status=pending is an admission state. Re-read and reconcile after 409. The example shows an abridged saved sequence with required reconciliation admitted.

Path parameters

  • sequence_idrequired

    string

    Sequence ID.

Query parameters

  • expectedUpdatedAt · optional

    string (ISO datetime)

    Saved updatedAt value used as an optimistic concurrency guard. The backend also compares the loaded configuration revision; concurrent changes return 409.

  • actorUserId · optional

    string

    Optional actor override; must resolve to an active user in the same org.

Body parameters

  • namerequired

    string

    Sequence name.

  • sourceTableId · optional

    string

    Optional in the model; required for developer API key requests.

  • sourceTableName · optional

    string

    Optional source table display name.

  • description · optional

    string

    Optional sequence description.

  • steps · optional

    array<object>

    Action content catalog referenced by flowGraph; array order does not determine execution. Defaults to []; developer API key requests must include at least one step.

  • exitRulesrequired

    object

    Exit behavior configuration.

  • schedulerequired

    object

    Timezone + working window configuration.

  • flowGraph · optional

    object

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

  • enrollmentRules · optional

    object

    Optional enrollment policy.

  • requiredVariables · optional

    array<string>

    Optional required template variables.

  • emailDelivery · optional

    object

    Delivery mode and provider settings; managed delivery is rejected.

  • inboxAccess · optional

    object

    Optional inbox access configuration.

  • senderAccountIds · optional

    object

    Optional channel-keyed sender account IDs.

  • senderBindings · optional

    object

    Optional channel-keyed sender binding definitions.

  • allowHqFallback · optional

    boolean

    Company-phone fallback for call steps when a lead phone is absent.

  • aiAutomationTrusted · optional

    boolean

    Trust flag for permitted AI-drafted automated steps.

  • aiDraftSettings · optional

    object

    Optional sequence AI-draft settings.

  • variableMap · optional

    object

    Optional variable-to-source-field mapping.

  • voiceStyle · optional

    object

    Optional voice style settings.

  • defaultAppendSignature · optional

    boolean

    Default signature behavior for email steps. Defaults to true when omitted.

  • steps[].appendSignature · optional

    boolean

    Step-level override for signature append behavior.

Errors

StatusMeaning
400Invalid payload or actor.
401Invalid API key or missing auth.
403Missing sequences:write scope.
404Sequence not found.
409Optimistic concurrency conflict or configuration cannot be applied.

Docs