Sequences

Set a sequence's recurring schedule

Changed on

Re-enrolls an audience into a manual-trigger sequence daily, on chosen weekdays, or on chosen days of the month (including the last day) at a time in an IANA timezone. Each run is an audience enrollment run with source recurring. Contacts who finished an earlier run enter again, contacts still in the sequence are skipped, one_time sequences never re-enroll anyone, and unsubscribed or bounced contacts never join. Nothing is enrolled until the first scheduled time. Occurrences while the sequence is paused, disabled or closed to new entrants are skipped, and a run that cannot start within 6 hours of its time is skipped (see lastSkipReason). A run waits while another audience enrollment is in progress. Replaces any existing schedule; an unchanged save keeps the pending next run. Changing the trigger away from manual switches the schedule off. Requires sequences:write.

put/sequences/{sequenceId}/recurring-enrollment

Request

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

Path parameters

sequenceIdstring required

Sequence ID.

Request body

enabledboolean

Defaults to true. False keeps the schedule but stops its runs.

endsAtstring date-time nullable

Optional. No run starts after this instant; omitted or null means no end date. Rejected when no run would happen before it.

enrollmentMode'unlimited' | 'one_time'

Optional. Sets the sequence's enrollment mode in the same save. unlimited re-enrolls everyone who matches at each run; one_time only adds people who never entered. This mode also applies to enrollments started by hand. Omit to keep the current mode.

Example request

{
  "audience": {
    "type": "lists",
    "listIds": [
      "list_abc123"
    ],
    "segmentId": "seg_abc123",
    "includedSubscriberIds": [
      "sub_abc123",
      "sub_def456"
    ]
  },
  "schedule": {
    "frequency": "monthly",
    "weekdays": [],
    "monthDays": [
      1,
      "last"
    ],
    "time": "10:00",
    "timezone": "Europe/London"
  },
  "endsAt": "2027-06-30T23:59:00Z"
}

Response

Schedule saved

successboolean
enrollmentMode'unlimited' | 'one_time' | 'matching_field'

The sequence's enrollment mode, which decides who enters at each run. unlimited enrolls everyone who matches (people still inside are skipped); one_time only adds people who never entered.

descriptionstring nullable

Readable summary of the schedule, including the timezone.

upcomingRunsstring[]

The next five run times. Empty while switched off or without a schedule.

messagestring

Present on writes.

Example response

{
  "success": true,
  "recurringEnrollment": {
    "enabled": true,
    "audience": {
      "type": "lists",
      "listIds": [
        "list_abc123"
      ],
      "segmentId": "seg_abc123",
      "includedSubscriberIds": [
        "sub_abc123",
        "sub_def456"
      ]
    },
    "schedule": {
      "frequency": "monthly",
      "weekdays": [],
      "monthDays": [
        1,
        "last"
      ],
      "time": "10:00",
      "timezone": "Europe/London"
    },
    "nextRunAt": "2026-11-30T10:00:00.000Z"
  },
  "description": "Monthly on the 1st and the last day at 10:00 (Europe/London)"
}

Changes