Sequence

object

idrequired: Id
Opaque record id.
namerequired: string
descriptionrequired: string or null
statusrequired: "draft" | "active" | "paused" | "archived"
stepsrequired: array of SequenceStep
entryrequired: object or null
entry.eventrequired: string
entry.filter: any or null
settingsrequired: object
settings.pause_onrequired: object
settings.pause_on.replyrequired: boolean
settings.pause_on.callrequired: boolean
settings.pause_on.visitrequired: boolean
versionrequired: integer
created_byrequired: object or null
created_by.idrequired: Id
Opaque record id.
created_by.namerequired: string
activated_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
archived_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
countsrequired: object
counts.activerequired: integer
counts.pausedrequired: integer
counts.completedrequired: integer
counts.exitedrequired: integer
counts.removedrequired: integer
counts.totalrequired: integer
can_editrequired: boolean
can_activaterequired: boolean
can_deleterequired: boolean
can_enrollrequired: boolean

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "description": "string",
  "status": "draft",
  "steps": [
    {
      "id": "string",
      "kind": "whatsapp",
      "label": "string",
      "delay": {
        "amount": 0,
        "unit": "minutes",
        "at": "string"
      },
      "window": {
        "start": "string",
        "end": "string",
        "days": [
          1
        ]
      },
      "template_id": "cmusrceel0000q7kaafxqi1om",
      "purpose": "promotional",
      "title": "string",
      "task_type": "follow_up",
      "description": "string",
      "assignee": "owner",
      "priority": "low"
    }
  ],
  "entry": {
    "event": "string",
    "filter": null
  },
  "settings": {
    "pause_on": {
      "reply": true,
      "call": true,
      "visit": true
    }
  },
  "version": 0,
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "activated_at": "2026-10-06T05:30:00.000Z",
  "archived_at": "2026-10-06T05:30:00.000Z",
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "counts": {
    "active": 0,
    "paused": 0,
    "completed": 0,
    "exited": 0,
    "removed": 0,
    "total": 0
  },
  "can_edit": true,
  "can_activate": true,
  "can_delete": true,
  "can_enroll": true
}

{ "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "description": "string", "status": "draft", "steps": [ { "id": "string", "kind": "whatsapp", "label": "string", "delay": { "amount": 0, "unit": "minutes", "at": "string" }, "window": { "start": "string", "end": "string", "days": [ 1 ] }, "template_id": "cmusrceel0000q7kaafxqi1om", "purpose": "promotional", "title": "string", "task_type": "follow_up", "description": "string", "assignee": "owner", "priority": "low" } ], "entry": { "event": "string", "filter": null }, "settings": { "pause_on": { "reply": true, "call": true, "visit": true } }, "version": 0, "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "activated_at": "2026-10-06T05:30:00.000Z", "archived_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "counts": { "active": 0, "paused": 0, "completed": 0, "exited": 0, "removed": 0, "total": 0 }, "can_edit": true, "can_activate": true, "can_delete": true, "can_enroll": true }