---
title: "Set a sequence's recurring schedule"
method: PUT
path: "/sequences/{sequenceId}/recurring-enrollment"
tags: ["Sequences"]
---

# Set a sequence's recurring schedule

`PUT /sequences/{sequenceId}/recurring-enrollment`

## Request

- Base URL: `https://api.sequenzy.com/api/v1`
- URL: `https://api.sequenzy.com/api/v1/sequences/{sequenceId}/recurring-enrollment`
- Auth: HTTP bearer

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`.

## Path parameters

- `sequenceId` string, required

## Request body

- object
  - `enabled` boolean: Defaults to true. False keeps the schedule but stops its runs.
  - `audience` SequenceAudience, required: Who to enroll. Same shape as campaign targetLists.
    - `type` 'all' | 'lists' | 'segment' | 'filtered' | 'rules', required
    - `listIds` string[]: For type lists.
    - `segmentId` string: For type segment.
    - `filters` object[]: For type filtered; subscriber filters.
    - `filterJoinOperator` 'and' | 'or'
    - `include` object[]: For type rules; include rules of type all, lists, segments, or filtered.
    - `exclude` object[]: For type rules; exclude rules.
    - `excludedSubscriberIds` string[]: Contacts removed from the include rules. Does not remove contacts listed in includedSubscriberIds.
    - `includedSubscriberIds` string[]: Specific contacts to enroll in addition to the include rules. Use type rules with an empty include array to enroll only these contacts, with no per-request cap. IDs that belong to another company, or to contacts who are unsubscribed, bounced or without an email, are skipped.
  - `schedule` SequenceRecurringSchedule, required: When a recurring sequence runs. Times are read in `timezone`, so runs stay at the same local time across daylight saving changes.
    - `frequency` 'daily' | 'weekly' | 'monthly', required
    - `weekdays` integer[]: Required for weekly, ignored otherwise. 0 is Sunday and 6 is Saturday; [1, 2, 3, 4, 5] is every weekday. Stored sorted and without duplicates; empty for other frequencies.
    - `monthDays` union[]: Required for monthly, ignored otherwise. Days 1 to 31 and/or "last" for the last day of the month. A day past the end of a shorter month runs on its last day (the 31st runs on February 28 or 29). Stored sorted with "last" at the end; empty for other frequencies.
      - union
        - integer
        - 'last'
    - `time` string, required: 24-hour wall-clock time. A time skipped by a daylight saving change runs just after the gap.
    - `timezone` string, required: IANA timezone such as Europe/London or UTC. Offsets like +02:00 are rejected.
  - `endsAt` string, 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.

## Response `200`

Schedule saved

- SequenceRecurringEnrollmentResponse
  - `success` boolean
  - `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.
  - `recurringEnrollment` SequenceRecurringEnrollment: A schedule that re-enrolls an audience into a manual-trigger sequence. Each run is an audience enrollment run with source `recurring`.
    - `enabled` boolean
    - `audience` SequenceAudience: Who to enroll. Same shape as campaign targetLists.
      - `type` 'all' | 'lists' | 'segment' | 'filtered' | 'rules', required
      - `listIds` string[]: For type lists.
      - `segmentId` string: For type segment.
      - `filters` object[]: For type filtered; subscriber filters.
      - `filterJoinOperator` 'and' | 'or'
      - `include` object[]: For type rules; include rules of type all, lists, segments, or filtered.
      - `exclude` object[]: For type rules; exclude rules.
      - `excludedSubscriberIds` string[]: Contacts removed from the include rules. Does not remove contacts listed in includedSubscriberIds.
      - `includedSubscriberIds` string[]: Specific contacts to enroll in addition to the include rules. Use type rules with an empty include array to enroll only these contacts, with no per-request cap. IDs that belong to another company, or to contacts who are unsubscribed, bounced or without an email, are skipped.
    - `schedule` SequenceRecurringSchedule: When a recurring sequence runs. Times are read in `timezone`, so runs stay at the same local time across daylight saving changes.
      - `frequency` 'daily' | 'weekly' | 'monthly', required
      - `weekdays` integer[]: Required for weekly, ignored otherwise. 0 is Sunday and 6 is Saturday; [1, 2, 3, 4, 5] is every weekday. Stored sorted and without duplicates; empty for other frequencies.
      - `monthDays` union[]: Required for monthly, ignored otherwise. Days 1 to 31 and/or "last" for the last day of the month. A day past the end of a shorter month runs on its last day (the 31st runs on February 28 or 29). Stored sorted with "last" at the end; empty for other frequencies.
        - union
          - integer
          - 'last'
      - `time` string, required: 24-hour wall-clock time. A time skipped by a daylight saving change runs just after the gap.
      - `timezone` string, required: IANA timezone such as Europe/London or UTC. Offsets like +02:00 are rejected.
    - `enabledAt` string, date-time: When the schedule was last switched on or changed.
    - `nextRunAt` string, date-time, nullable: Next occurrence. Null while switched off.
    - `lastRunAt` string, date-time, nullable: Occurrence of the most recent run that started.
    - `lastRunId` string, nullable: Audience enrollment run started for lastRunAt.
    - `lastSkippedAt` string, date-time, nullable: Occurrence of the most recent skipped run.
    - `lastSkipReason` 'not_accepting' | 'missed' | 'null', nullable: not_accepting when the sequence was paused, disabled or closed to new entrants; missed when the run could not start within 6 hours of its time.
    - `endsAt` string, date-time, nullable: No run starts after this instant. Null repeats until switched off. Once nothing is left before it, nextRunAt is null while enabled stays true.
  - `description` string, nullable: Readable summary of the schedule, including the timezone.
  - `upcomingRuns` string[]: The next five run times. Empty while switched off or without a schedule.
  - `message` string: Present on writes.

## Other responses

- `400`: Invalid schedule or audience, the sequence trigger is not manual, or keep-enrolling (audienceAutoEnroll) is on
- `401`: Unauthorized
- `403`: The API key lacks the required scope
- `404`: Sequence not found

## Changes

- **2026-11-05** `3b203b095366`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sequenzy/apis/sequenzy-api/changes/sequences/:sequenceId/recurring-enrollment/put.md)

---

[API](https://skmtc.dev/sequenzy/apis/sequenzy-api.md) - [All operations](https://skmtc.dev/sequenzy/apis/sequenzy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sequenzy/apis/sequenzy-api/revisions/e5af1fb27c8d?raw)
