Schedule

A Schedule defines a reminder sequence for outgoing documents. Each schedule belongs to a Group and contains one or more ScheduleItems that define when and how reminders are sent.

Fields

Field	Type	Description
id	ID	Unique identifier
name	String	Schedule name
default	Boolean	Whether this is the default schedule for the group
active	Boolean	Whether the schedule is active

Relationships

Field	Type	Description
group	Group	The group this schedule belongs to
items	[ScheduleItem]	Reminder items in this schedule

Query

Schedules are accessed via Group.scheduleConnection:

query GetGroupSchedules {
  group(id: "Z3JwbGVnYWxlc2lnbxRldg==") {
    scheduleConnection {
      schedules {
        id
        name
        default
        active
        items {
          id
          daysAfter
          frequency
          subject
          message
          when
          timeOfDay
          skipWeekend
        }
      }
    }
  }
}

Related

• ScheduleItem — individual reminder items
• Group — the group this schedule belongs to
• Recipient — recipients can have custom schedules