Sequences

Push sequence definition

Changed on

Creates the sequence with this key, or updates it to match the document. Steps are matched by key: new keys are added, changed steps are updated in place, and missing steps are removed, with waiting contacts moved to the following step (or completed when nothing follows). A push never turns a sequence on or off or pauses it; new sequences start as drafts.

put/sequences/definitions/{key}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • Auth
    HTTP bearer

Path parameters

keystring required

Query parameters

dryRunboolean

Return the changes without saving them.

confirmLiveChangeboolean

Required when the change affects an active sequence.

Request body

keystring

Your key for the sequence. Optional on PUT (the URL key is used); must match the URL when present. Empty on GET for a sequence that has no key yet.

idstring

Read-only sequence ID. On PUT, adopts that existing sequence when it has no key yet.

namestring required
descriptionstring nullable
managedBy'code' | 'dashboard'

code makes steps and settings read-only in the dashboard while on/off, pause and test sends stay available. New sequences default to code; existing ones keep their value when omitted. Marketer personal keys cannot change it on an existing sequence. Not returned on GET, so a pulled document pushed back never changes it.

statusstring

Informational. Pushes accept and ignore it, and never change status.

Response

Sequence updated, unchanged, or previewed with dryRun

successboolean
dryRunboolean
createdboolean
hasChangesboolean
warningsstring[]
errorstring

Changes