API Reference
Log In
API Reference

Create a Reminder

Creates a Reminder. Use the request body to set parameter values including the Reminder name, message, schedule, and recipients.

The resource is the entity the Reminder should be linked to. This can be a Drawer (sidedrawer/sidedrawerId), Folder (sidedrawer/sidedrawerId/record/recordId), or Plan Request (sidedrawer/sidedrawerId/plan-request/planRequestId).

The schedule entity includes the start date and an optional recurrent entity that describes when the Reminder should repeat.

The to entity accepts both OpenIDs and emails, so you can send Reminders to people internally or externally.

Body Params
string
required

Message name.

string
required

Resource path of entity.

string
required

Reminder message.

schedule
object
required

Describes when the Reminder is sent.

to
object

Describes to whom the Reminder is sent.

string

Message type.

Response

Language
Credentials