latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Location reminders

Create Location Reminder

Create a new location reminder for a task.

post/api/v1/location_reminders

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)

Example request

{
  "task_id": "6XGgmFVcrG5RRjVr",
  "name": "Home",
  "loc_lat": "37.7749",
  "loc_long": "-122.4194",
  "loc_trigger": "on_enter",
  "radius": 100
}

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