Reminders

View reminders

Please be aware that once reminders are sent, they are removed from the list. This includes both one-time reminders and recurring reminders. As a result, you will not see any reminders that have already been dispatched.

View reminders

GET https://web.r0app.com/api/v1/orgs/:org_id/reminders

Returns a paginated list of your reminders.

Query Parameters

Name	Type	Description
page	Integer	For more info, see the pagination section in the Getting started guide.
limit	Integer	For more info, see the pagination section in the Getting started guide.

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/reminders \
    -X GET \
    -H 'Authorization: Bearer <token>'

Create a reminder

Create a reminder

POST https://web.r0app.com/api/v1/orgs/:org_id/reminders

Request Body

Name	Type	Description
user_reminder[remind_by]	String	Options include email or push (mobile push notification, if enabled on mobile first)
user_reminder[repeat_every_unit]	String	Options include hour, day, or week
user_reminder[repeat_every_magnitude]	Integer	This field should be equal to the number you'd like between your reminders. E.g. if you wanted to be reminded every other week set this to 2 and the field above to week.
user_reminder[schedule_at]	String	The scheduling time is a slight modification of the ISO8601 time format; Y-m-dTH:M. E.g. 2023-12-25 05:59 (please note the "T" is required and cannot be a space)
user_reminder[title]	String
user_reminder[repeat_count]	Integer	Represents the number of reminders you'll receive

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/reminders \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -F 'user_reminder[remind_by]=email' \
    -F 'user_reminder[schedule_at]=2023-12-25T05:59' \
    -F 'user_reminder[title]=Example reminder' \
    -F 'user_reminder[repeat_every_unit]=week' \
    -F 'user_reminder[repeat_every_magnitude]=1' \
    -F 'user_reminder[repeat_count]=52'

Update a reminder

Create a reminder

PATCH https://web.r0app.com/api/v1/orgs/:org_id/reminders/:reminder_id

Request Body

Name	Type	Description
user_reminder[remind_by]	String	Options include email or push (mobile push notification, if enabled on mobile first)
user_reminder[repeat_every_unit]	String	Options include hour, day, or week
user_reminder[repeat_every_magnitude]	Integer	This field should be equal to the number you'd like between your reminders. E.g. if you wanted to be reminded every other week set this to 2 and the field above to week.
user_reminder[schedule_at]	String	The scheduling time is a slight modification of the ISO8601 time format; Y-m-dTH:M. E.g. 2023-12-25 05:59 (please note the "T" is required and cannot be a space)
user_reminder[title]	String
user_reminder[repeat_count]	Integer	Represents the number of reminders you'll receive

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/reminders/:reminder_id \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -F 'user_reminder[repeat_every_unit]=year'

Delete a reminder

Delete a reminder

DELETE https://web.r0app.com/api/v1/orgs/:org_id/reminders/:reminder_id

Path Parameters

Name	Type	Description
Reminder id*	UUID

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/reminders/:reminder_id \
    -X POST \
    -H 'Authorization: Bearer <token>'