Skip to main content

ScheduleItem

A ScheduleItem defines a single reminder rule within a Schedule. Reminders are sent a number of days after the document was sent, and can repeat at a set frequency.

Fields

FieldTypeDescription
idIDUnique identifier
daysAfterIntDays after the document was sent to send the reminder
frequencyIntDays between follow-ups (0 = no follow-up)
subjectStringOptional email subject line
messageStringOptional email message body
whenIntTrigger condition: 1=signer hasn't visited, 2=document not completed, 3=send anyway
timeOfDayAWSTimeTime of day to send
skipWeekendBooleanSkip weekends
messageSentAWSDateTimeWhen the reminder was last sent
messageSeenBooleanWhether the recipient saw the reminder
sendAttemptedBooleanWhether a send was attempted
utcSendTimeAWSDateTimeUTC time the reminder was sent
sendTimeAWSTimeScheduled send time

Relationships

FieldTypeDescription
scheduleScheduleThe parent schedule
  • Schedule — the parent schedule
  • Recipient — recipients can have per-recipient schedule overrides

Export This Article

Save a copy of this page as PDF or plain text.