Skip to main content
PATCH

Path Parameters

sequence_template_id
string<uuid>
required

Body

application/json

Request body for updating a sequence template. All fields optional.

name
string | null

New name for the sequence template

Minimum string length: 1
Example:

"Enterprise Onboarding v2"

description
string | null

New description for the sequence template

status
enum<string> | null

New status for the sequence template

Available options:
ACTIVE,
INACTIVE,
ARCHIVED
Example:

"ACTIVE"

steps
UpdateSequenceTemplateStepRequest · object[] | null

Full replacement of the step list. Include id on steps that should keep their identity; omit id to assign a new one. transitions is required in the same request.

transitions
SequenceTemplateTransitionRequest · object[] | null

Replacement list of transitions. Must be supplied together with steps; [] is only valid for a single-step template.

Response

Successful Response

data
SequenceTemplateDetailResponse · object
required

Sequence template with its ordered list of steps and transitions.

meta
ResponseMeta · object