Recurrent

Recurrent entity

frequency

  

string

   

The frequency with which the Reminder should be repeated. Possible values: Daily, Weekly, Monthly, Yearly.

---

iteration

  

number

   

Describes how often the frequency is considered for cases in which Reminder schedules are more complex than the options provided in frequency. For example, to send a Reminder every two weeks, set frequency = Weekly and iteration = 2. To send a Reminder every quarter, set frequency = Monthly and iteration = 3 - a Reminder will be sent every three months. To send a Reminder every 6 months, set frequency = Monthly and iteration = 6.

---

pattern

  

string

   

Describes specifically when a Reminder will recur. This is not applicable when frequency = Daily. For frequency = Weekly, the possible values for pattern are enums describing the day(s) of the week the Reminder should be sent. Possible values: Sun, Mon, Tue, Wed, Thu, Fri, Sat.For frequency = Monthly, the possible values for pattern are days of the month in the format "dd". Possible values range from 01 to 28. 29, 30, and 31 are not supported values.For frequency = Yearly, the possible values for pattern represent a specific day of the year in the format "mm/dd". Note: using 02/29 will cause the Reminder to be sent only on leap years.

---

endDate

  

string

   

Describes the last date the Reminder should be sent in ISO 8601 format.

---

skipCondition

  

string

   

Condition evaluated when the Reminder runs. When true, the message isn't sent.

---