Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Reminders

Create Reminder

Create a new reminder for a task.

For relative reminders, provide minute_offset (minutes before the task's due time). For absolute reminders, provide a due dictionary with a specific date/time. Supported due keys are date or string, with optional lang, timezone, and is_recurring.

post/api/v1/reminders

Request body

task_idstring required

String ID of the task

reminder_type'relative' | 'absolute'

Type of the reminder: 'relative' or 'absolute'

minute_offsetinteger nullable

Minutes before due time to trigger (for relative reminders)

is_urgentboolean

Whether the reminder is an urgent reminder. Urgent reminders trigger an alarm notification on the user's designated urgent reminder device.

Example request

{
  "task_id": "6XGgmFVcrG5RRjVr",
  "reminder_type": "relative",
  "minute_offset": 30,
  "due": {
    "date": "2025-02-12T09:00:00",
    "string": "tomorrow at 9am",
    "lang": "en",
    "timezone": "Europe/Madrid"
  }
}

Response

Successful Response

idstring required

String ID of the reminder.

item_idstring required

String ID of the task that owns the reminder.

notify_uidstring required

String ID of the user who receives the reminder.

is_deletedboolean required

Whether the reminder is deleted.

is_urgentboolean required

Whether the reminder should be delivered urgently.

typestring required

Reminder type.

minute_offsetinteger nullable required

Minutes before the task due time for relative reminders.

dueobject nullable required

Datetime when the reminder fires, or null if unset.

Example response

{
  "id": "6XGgmFQrx44wfGHr",
  "item_id": "6XGgmFVcrG5RRjVr",
  "notify_uid": "1234567",
  "type": "relative",
  "minute_offset": 30,
  "due": {
    "date": "2025-02-12T09:00:00",
    "lang": "en",
    "timezone": "Europe/Madrid"
  }
}