TOtodoist
Location reminders

Create Location Reminder

Changed on

Create a new location reminder for a task.

post/api/v1/location_reminders

Request

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

Request body

task_idstring required

String ID of the task

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: 'on_enter' or 'on_leave'

radiusinteger

Radius in meters (default 100, max 255)

notify_uidstring nullable

String ID of the user who receives the reminder. Must be a collaborator of the task's project. Defaults to the user creating the reminder. To find User IDs, use Get user for your own ID or Get all collaborators for project members.

Example request

{
  "task_id": "6XGgmFVcrG5RRjVr",
  "name": "Home",
  "loc_lat": "37.7749",
  "loc_long": "-122.4194",
  "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