messaging

Create a reminder for a place

Once you have looked up an address to find a schedule, you can create a reminder. This reminder will periodically notify you about your collection schedule.

The JSON body fields should be as follows:

  • place_id - the ID of the place, from previous lookups
  • service - the service_id, from previous lookups
  • target - the recipient of the reminder. See below.
  • email - the email address of the reminder creator.
  • day_offset - The day the reminder should be sent - 0 is same day, 1 is day after, 2 is in 2 days, -1 is day before the event.
  • time_of_day - when the reminder should be sent, as specified as a HH:MM:SS 24 hour time of day. Combined with day_offset
  • locale - the locale the reminder notifications should use.

The target parameter should be in one of the following forms, describing the recipient.

  • email:EMAIL_ADDRESS - Email reminder
  • sms:PHONE_NUMBER - SMS / Text Message reminder
  • voice:PHONE_NUMBER - Voice call reminder
  • ical:email:EMAIL_ADDRESS - iCal "alert-only" reminder
  • print:email:EMAIL_ADDRESS - PDF "alert-only" reminder
  • alert:email:EMAIL_ADDRESS - Alert-only reminder
post/places/{place_id}/services/{svc_id}/reminders

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/places/{place_id}/services/{svc_id}/reminders
  • Auth: none declared

Path parameters

place_idstring required

Place ID is the UUID for a given place within ReCollect

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Request body

emailstring
time_of_daystring duration
localestring
place_idstring
serviceinteger
zone_namestring
targetstring
day_offsetinteger

Response

201 Created

day_offsetinteger
last_notifiedstring date-time
confirmedboolean
zone_namestring
localestring
disabledboolean
created_atstring date-time
targetstring
idstring
place_namestring
time_of_daystring

Changes

No recorded changes to this operation across all 1 revision of this API.