TOtodoist
Location reminders

Update Location Reminder

Changed on

Update an existing location reminder.

post/api/v1/location_reminders/{reminder_id}

Request

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

Path parameters

reminder_idstring required

String ID of the location reminder

Example:6XGgmFQrx44wfGHr

Request body

namestring nullable

Name of the location. If not provided (or null), the value remains unchanged.

loc_latstring nullable

Latitude of the location. If not provided (or null), the value remains unchanged.

loc_longstring nullable

Longitude of the location. If not provided (or null), the value remains unchanged.

loc_trigger'on_enter' | 'on_leave' nullable

Trigger type: 'on_enter' or 'on_leave'. If not provided (or null), the value remains unchanged.

radiusinteger nullable

Radius in meters. If not provided (or null), the value remains 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

{
  "name": "Office",
  "loc_lat": "40.416775",
  "loc_long": "-3.703790",
  "loc_trigger": "on_enter",
  "radius": 100,
  "notify_uid": "1234567"
}

Response

Successful Response

idstring required

String ID of the location reminder

item_idstring required

String ID of the task

project_idstring required

String ID of the project containing the task

notify_uidstring required

String ID of the user who will receive the reminder

namestring required

Name of the location

loc_latstring required

Latitude of the location

loc_longstring required

Longitude of the location

loc_trigger'on_enter' | 'on_leave' required

Trigger type for the location reminder

radiusinteger required

Radius in meters

is_deletedboolean required

Whether the location reminder is deleted

type'location'

The reminder type

Example response

{
  "id": "6XGgmFQrx44wfGHr",
  "item_id": "6XGgmFVcrG5RRjVr",
  "project_id": "6XGgm6PHrGgMpCFX",
  "notify_uid": "1029384756",
  "name": "Home",
  "loc_lat": "37.7749",
  "loc_long": "-122.4194",
  "loc_trigger": "on_enter",
  "radius": 100,
  "type": "location"
}

Changes