Delete Geo Location

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/geolocations/delete

Overview

Soft-deletes a geolocation by setting its deleted flag.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

• Required permission: Delete on the geo feature
• Additional rules:
  • Only global admins can delete global (non-app-specific) locations.
  • App admins can delete only locations in apps they administer.

Request Parameters

Parameter	Type	Required	Description
api_key	String	Yes (or auth_token)	API key authentication
auth_token	String	Yes (or api_key)	Auth token authentication
app_id	String	Yes	Application context for permission checks
gid	String	Yes	Geolocation ID (24-char ObjectID)

Examples

Example: Delete a Geolocation

https://your-server.com/i/geolocations/delete?api_key=YOUR_API_KEY&app_id=609bd78d90d7a416d4dfb984&gid=62616692a9ddc55457bad406

Response

Success Response

{
  "_id": "62616692a9ddc55457bad406",
  "title": "Berlin Store",
  "radius": 5,
  "unit": "km",
  "geo": {
    "type": "Point",
    "coordinates": [13.405, 52.52]
  },
  "app": "609bd78d90d7a416d4dfb984",
  "address": "Berlin, Germany",
  "deleted": true
}

Response Fields

Field	Type	Description
_id	String	Deleted geolocation ID
title	String	Location title
radius	Number	Radius value
unit	String	Unit label
geo	Object	Location point
app	String	App ID (if app-specific)
address	String	Stored address
deleted	Boolean	Always true after successful deletion

Error Responses

HTTP Status	Response
400	{"result":"Not enough args"}
404	{"result":"Location not found"}
403	{"result":"Only global admin can delete non-app-specific geolocations"}
403	{"result":"Only admin of app can can delete geolocations"}

Behavior

1. Validates gid format and permissions.
2. Loads the geolocation scoped to the request app.
3. Marks the record as deleted (deleted: true).
4. Returns the updated location object.

Related Endpoints

• Geo - Create Geo Location
• Geo - List Geo Locations

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
countly.geos	Endpoint data source	** - Finds and soft-deletes geolocation records