v1

latestOpenAPI 3.1.02026-07-263788129.7 KB

Sequences

Update a Sequence

Applies a state transition to a sequence (see the action field for valid values and their meanings). Returns the refreshed sequence representation, including its tasks.

patch/v1/sequences/{sequence_id}

Path parameters

sequence_idstring uuid required

Request body

action'pause' | 'resume' | 'stop' | 'enqueue' required

User-callable state transitions on a sequence.

Intentionally a subset of campaigns.schemas.SequenceActionEnum: system-only transitions (success, fail) and the payload-bearing update_copy transition are excluded.

Response

Successful Response

Example response

{
  "data": {
    "id": "seq_abc123",
    "contact_id": "con_def456",
    "name": "Enterprise Onboarding",
    "description": "Multi-touch onboarding sequence for enterprise accounts",
    "status": "started",
    "template_id": "seqt_789ghi",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-05-10T14:22:00Z",
    "last_interaction": "Email today",
    "enqueued_at": "2026-01-16T09:00:00Z",
    "started_at": "2026-01-16T09:05:00Z",
    "responded_at": "2026-01-20T11:30:00Z",
    "meeting_booked_at": "2026-01-22T15:00:00Z",
    "sender_id": "usr_jkl012",
    "sender_name": "Alex Rivera",
    "tasks": [
      {
        "id": "tsk_abc123",
        "sequence_id": "seq_def456",
        "order": 1,
        "name": "Send intro email",
        "scheduled_at": "2026-05-15T09:00:00Z",
        "completed_at": "2026-05-15T10:00:00Z"
      }
    ]
  }
}