Reminders

View a contact's reminders

Fetch a list of a contact's reminders

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

Returns a paginated list of a contact's 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/contacts/:contact_id/reminders \
    -X GET \
    -H 'Authorization: Bearer <token>'

Create a reminder

Create a reminder

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_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[category]	String	custom
user_reminder[schedule_before_unit]	String	Options include minute, hour, day, or week
user_reminder[schedule_before_magnitude]	Integer	This field should be equal to the number of schedule_before_unit(s) you'd like to be reminded. e.g. 2 week(s) would remind youd

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/reminders \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -F 'note[note]=This is an example.' \
    -F 'contacts[]=b0063875-54e1-45e4-94de-72545fdc88a7'

Upload an attachment

Upload an attachment

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/attachments

Request Body

Name	Type	Description
upload	File

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/attachments \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -F '[email protected]'

Delete an attachment

NOTE: your attachment will be deleted from our servers immediately. There is no recourse for this action, proceed with caution.

Delete an attachment

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/attachments/:attachment_id

Path Parameters

Name	Type	Description
:contact_id*	String
:attachment_id*	String

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/attachments/:attachment_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'