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_idrequiredstring
Sequence ID.
| Name | Type | Description |
|---|---|---|
| sequence_idrequired | string | Sequence ID. |
Query parameters
expectedUpdatedAt· optionalstring (ISO datetime)
Saved updatedAt value used as an optimistic concurrency guard. The backend also compares the loaded configuration revision; concurrent changes return 409.
actorUserId· optionalstring
Optional actor override; must resolve to an active user in the same org.
| Name | Type | Description |
|---|---|---|
| expectedUpdatedAt | 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 | string | Optional actor override; must resolve to an active user in the same org. |
Body parameters
namerequiredstring
Sequence name.
sourceTableId· optionalstring
Optional in the model; required for developer API key requests.
sourceTableName· optionalstring
Optional source table display name.
description· optionalstring
Optional sequence description.
steps· optionalarray<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.
exitRulesrequiredobject
Exit behavior configuration.
schedulerequiredobject
Timezone + working window configuration.
flowGraph· optionalobject
Required when actions exist, including straight-line sequences. Declare version=1, exactly one entryNodeIds node, action nodes, and explicit routing edges.
enrollmentRules· optionalobject
Optional enrollment policy.
requiredVariables· optionalarray<string>
Optional required template variables.
emailDelivery· optionalobject
Delivery mode and provider settings; managed delivery is rejected.
inboxAccess· optionalobject
Optional inbox access configuration.
senderAccountIds· optionalobject
Optional channel-keyed sender account IDs.
senderBindings· optionalobject
Optional channel-keyed sender binding definitions.
allowHqFallback· optionalboolean
Company-phone fallback for call steps when a lead phone is absent.
aiAutomationTrusted· optionalboolean
Trust flag for permitted AI-drafted automated steps.
aiDraftSettings· optionalobject
Optional sequence AI-draft settings.
variableMap· optionalobject
Optional variable-to-source-field mapping.
voiceStyle· optionalobject
Optional voice style settings.
defaultAppendSignature· optionalboolean
Default signature behavior for email steps. Defaults to true when omitted.
steps[].appendSignature· optionalboolean
Step-level override for signature append behavior.
| Name | Type | Description |
|---|---|---|
| namerequired | string | Sequence name. |
| sourceTableId | string | Optional in the model; required for developer API key requests. |
| sourceTableName | string | Optional source table display name. |
| description | string | Optional sequence description. |
| steps | 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 | object | Required when actions exist, including straight-line sequences. Declare version=1, exactly one entryNodeIds node, action nodes, and explicit routing edges. |
| enrollmentRules | object | Optional enrollment policy. |
| requiredVariables | array<string> | Optional required template variables. |
| emailDelivery | object | Delivery mode and provider settings; managed delivery is rejected. |
| inboxAccess | object | Optional inbox access configuration. |
| senderAccountIds | object | Optional channel-keyed sender account IDs. |
| senderBindings | object | Optional channel-keyed sender binding definitions. |
| allowHqFallback | boolean | Company-phone fallback for call steps when a lead phone is absent. |
| aiAutomationTrusted | boolean | Trust flag for permitted AI-drafted automated steps. |
| aiDraftSettings | object | Optional sequence AI-draft settings. |
| variableMap | object | Optional variable-to-source-field mapping. |
| voiceStyle | object | Optional voice style settings. |
| defaultAppendSignature | boolean | Default signature behavior for email steps. Defaults to true when omitted. |
| steps[].appendSignature | boolean | Step-level override for signature append behavior. |
Errors
| Status | Meaning |
|---|---|
| 400 | Invalid payload or actor. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing sequences:write scope. |
| 404 | Sequence not found. |
| 409 | Optimistic concurrency conflict or configuration cannot be applied. |
