Sign in

v1

latestOpenAPI 3.1.02026-07-263788129.7 KB
Sequence Templates

Update a Sequence Template

Updates an existing sequence template. All fields are optional, but at least one must be provided. steps, transitions, and blocks replace the current value when supplied; each supplied step must include its id.

Supply steps (ordered by index), transitions, and blocks together; see each field's schema for its shape and allowed values. A step references a block via a [[block:<id>]] marker in its message/subject, and a transition links steps by index sequentially or on a branch. Example:

{"steps": [{"index": 1, "day": 0, "hour": 9, "type": "auto_email", "subject": "Quick question", "message": "<p>Hi {{recipient.first_name}} [[block:intro]]</p>"}, {"index": 2, "day": 2, "hour": 9, "type": "auto_linkedin_connection", "message": "Let's connect"}], "transitions": [{"from_step_index": 1, "to_step_index": 2, "transition_type": "PREVIOUS_STEP_COMPLETES"}], "blocks": {"intro": {"name": "Intro", "block_type": "MANUAL", "content": "..."}}}

Template variables must be namespaced. Supported tokens are {{recipient.first_name}}, {{recipient.last_name}}, {{recipient.company}}, {{recipient.email}}, {{sender.first_name}}, {{sender.last_name}}, and {{sender.company}}.

patch/v1/sequence-templates/{sequence_template_id}

Path parameters

sequence_template_idstring uuid required

Request body

namestring nullable

New name for the sequence template

descriptionstring nullable

New description for the sequence template

status'ACTIVE' | 'INACTIVE' | 'ARCHIVED'

User-settable sequence-template statuses.

Intentionally a subset of campaigns.types.sequence_template.CampaignStatusEnum: excludes DRAFT, an internal-only authoring state.

blocksobject nullable

Replacement content blocks referenced by this template

Example request

{
  "name": "Enterprise Onboarding v2",
  "steps": [
    {
      "index": 1,
      "title": "Intro email",
      "hour": 9
    }
  ],
  "transitions": [
    {
      "from_step_index": 1,
      "to_step_index": 2,
      "pre_check_delay": 2,
      "post_check_delay": 1
    }
  ]
}

Response

Successful Response

Example response

{
  "data": {
    "id": "seqt_abc123",
    "name": "Enterprise Onboarding",
    "description": "Multi-touch onboarding sequence for enterprise accounts",
    "owner_id": "usr_abc123",
    "archived_at": "2026-05-10T14:22:00Z",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-05-10T14:22:00Z",
    "steps": [
      {
        "id": "stp_abc123",
        "index": 1,
        "title": "Intro email",
        "hour": 9
      }
    ],
    "transitions": [
      {
        "from_step_index": 1,
        "to_step_index": 2,
        "pre_check_delay": 2,
        "post_check_delay": 1
      }
    ]
  }
}