Skip to content

Reminder

HTTP API schema

← HTTP API reference

A reminder and its current provider revision for guarded edits.

Reminder fields

reminderIdstringRequired
listIdstringRequired
titlestringRequired
notesstring
completedbooleanRequired
dueDatestring

Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.

format: "date-time"

timeZonestring

IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.

allDayboolean

Whether the supplied due date represents an all-day reminder.

revisionstring

Omitted when the provider does not supply a revision; writes require it.

View source specification ↗