Reminders

Last Updated: July 20, 2015

Following is a list of the properties that belong to a reminder object, and a description of each.

id:
Integer. Read-only. Id of reminder.
user_id:
Integer. Read-only. Id of the user that this reminder pertains to. A user_id of 0 indicates that this is a company-wide reminder.
reminder_type:
String. The type of this reminder object. Supported reminder_types are 'clock-in' and 'clock-out'.
due_time:
String. The 24-hour time that the reminder should be sent, expressed as "hh:mm:ss". The time should be in the recipient user's local time and must be in even 5 minute increments. For example: 13:45:00 or 08:00:00.
due_days_of_week:
String. A comma-separated list of the days of the week when the reminder should be sent. The value can be any combination of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri' and 'Sat'. For example: 'Mon,Tue,Wed,Thu,Fri' or 'Tue,Sat'.
distribution_methods:
A comma-separated list of the transport method(s) indicating how the reminder message should be sent. The value can be any combination of 'Push', 'SMS' and 'Email'. For example: "Push,SMS". The 'Push' method utilizes the TSheets mobile app to deliver the notification to a mobile device.
active:
Boolean. true or false. If true, this reminder is active and will be evaluated at the 'due_time' and 'due_days_of_week'. If false, this reminder is inactive and will not be evaluated. If active = false for user-specific reminders, then the company-wide reminder of the same reminder type will apply.
enabled:
Boolean. true or false. If true, the reminder is enabled and will be sent at the 'due_time' and 'due_days_of_week'. If false, the reminder is disabled and will not be sent. A user with an active (active = true), but disabled (enabled = false) reminder will not receive that reminder type regardless of how company-wide reminders are configured.
last_modified:
String (ISO8601 format). Read-only. Date/time when this reminder was last modified (i.e. 2015-07-15T19:31:43+00:00).
created:
String (ISO8601 format). Read-only. Date/time when this reminder was created (i.e. 2015-07-15T19:16:19+00:00).