Favorites

Favorite places and areas you name yourself. Stays inside a favorite use its name instead of the reverse-geocoded address. Adding, deleting, or moving a favorite starts a timeline regeneration in the background so existing stays pick up the change.

📄️ List favorites

Returns all favorite points and areas of the signed-in user with their names, cities, and countries.

📄️ Add a favorite area

Creates a favorite covering a rectangular area, such as a campus or a park. Stays inside the area use the favorite's name. Starts a background timeline regeneration so existing stays pick up the change; the response contains the job ID to poll with `GET /api/v1/timeline/jobs/{jobId}`.

📄️ Add several favorites

Creates several favorite points and areas in one request. The response reports which ones succeeded. A single timeline regeneration job is started for all of them.

📄️ Set city or country of several favorites

Sets the city, the country, or both, on several favorites at once, for example to fix inconsistent names.

📄️ Add a favorite point

Creates a favorite at a single location. Stays near the point use the favorite's name. Starts a background timeline regeneration so existing stays pick up the change; the response contains the job ID to poll with `GET /api/v1/timeline/jobs/{jobId}`.

📄️ Re-resolve favorite addresses

Starts a background job that looks up the city and country of favorites again with a chosen geocoding provider. Pass specific `favoriteIds`, or set `reconcileAll` with optional filters. Only one reconciliation job per user can run at a time. Poll `GET /api/v1/favorites/reconcile/jobs/{jobId}` for progress.