A Reminder can be attached to an entity such as a Drawer (sidedrawer
) or Folder (record
) and has lots of flexibility in terms of when it should be delivered to recipients via email. Once created, a Reminder has a unique reminderId
by which it is accessible.
{
"name": "My reminder",
"resource": "sidedrawer/{sidedrawerId}", /*This reminder is linked to a drawer*/
"message": "This is what I want to be reminded of",
"schedule": {
"startDate": "2024-08-09T16:00:00.000Z", /*This reminder will occur every 2 weeks on Fridays*/
"recurrent": {
"frequency": "Weekly",
"iteration": 2,
"pattern": "Fri",
"endDate": "2024-09-20T16:00:00.000Z",
"skipCondition": "complete"
}
},
"to": {
"openIds": [
"auth0|12345abcde"
],
"emails": []
},
"messageType": "scheduledReminder"
}
Reminder entity
name
string required
Reminder name.
resource
string required
Path of the entity to which the Reminder is linked. There are three available "levels" of resources:
- Drawer (
sidedrawer
) level: the path root will besidedrawer/sidedrawerId
- Folder (
record
) level: the path root will besidedrawer/sidedrawerId/record/recordId
- Plan Request level: the path root will be
sidedrawer/sidedrawerId/plan-request/planRequestId
message
string required
Reminder message.
schedule
entity required
Describes when the Reminder is sent.
to
entity
Describes to whom the Reminder is sent.
messageType
enum
Message type.
Possible values: reminder
, sfr
, shareFile
, directMsg
, scheduledReminder
.
Schedule (schedule
) entity
schedule
) entitystartDate
date-time string required
Reminder start date in ISO 8601 format.
recurrent
entity
Describes the recurrent nature of the Schedule entity, if applicable.
Recurrent (recurrent
) entity
recurrent
) entityfrequency
enum
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 forpattern
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 forpattern
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
date-time string
Describes the last date the Reminder should be sent in ISO 8601 format.
skipCondition
enum
Condition evaluated when the Reminder runs. When true, the message isn't sent. Possible value: complete
.
To (to
) entity
to
) entityopenIds
array of strings
OpenID(s) to which to deliver the message.
emails
array of strings
Email address(es) to which to deliver the message.