TOtodoist
Reminders

Update Reminder

Changed on

Update an existing reminder.

post/api/v1/reminders/{reminder_id}

Request

  • Base URL
    https://api.todoist.com
  • URL
    https://api.todoist.com/api/v1/reminders/{reminder_id}
  • Auth
    none declared

Path parameters

reminder_idstring required

String ID of the reminder

Example:6XGgmFQrx44wfGHr

Request body

minute_offsetinteger nullable

Minutes before due time to trigger (for relative reminders).

service'email' | 'push'
is_urgentboolean

Whether the reminder is an urgent reminder. Urgent reminders trigger an alarm notification on the user's designated urgent reminder device. Omit this field to keep it unchanged.

notify_uidstring nullable

String ID of the user who receives the reminder. Must be a collaborator of the task's project. To find User IDs, use Get user for your own ID or Get all collaborators for project members. Passing null or omitting this field will leave it unchanged.

Example request

{
  "minute_offset": 30,
  "due": {
    "date": "2025-02-12T09:00:00",
    "string": "tomorrow at 9am",
    "lang": "en",
    "timezone": "Europe/Madrid"
  },
  "notify_uid": "1234567"
}

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"
  }
}

Changes

  • add263bd83eeRevision changes
    • info

      added the new optional request property

  • 44182406bec7Revision changes
    • breaking

      removed from the request property anyOf list

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • info

      added the new email enum value to the request property

    • info

      added the new push enum value to the request property