Skip to content

Deleting a Geo Category

This API deletes a geo category. If the category does not exist, the service returns an error.

Removing Categories in Console

Backendless Console supports category deletion via the graphical interface. To delete a category:

  1. Login to Backendless Console
  2. Select your app/backend.
  3. Click the Geolocation icon in the menu on the left.
  4. Use the "delete" icon in the section above the list of categories:
    delete-geo-category

  5. Select DELETE in the confirmation popup.


Deleting Categories with the API

Method

DELETE

URL

https://api.backendless.com/<application-id>/<REST-api-key>/geo/categories/<categoryName> 

where:

Argument                Description
<application id> ID of the application which can be obtained from the Manage > App Settings screen of the Backendless Console
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.
<categoryName> name of the category to delete.

Request headers

Content-Type: application/json  
user-token: optional value obtained as a result of the login operation.

where:

Argument                Description
Content-Type Must be set to application/json. This header is mandatory.
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-token is set in the request, the currently logged in user will be assigned to the ownerId property of the user object which is being saved.  Additionally, the operation will be executed with the security policy associated currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Response Body

A JSON object wit a boolean value indicating whether the category has been successfully deleted:

{  
  "result": true | false  
}

If an error occurs, the response is formatted as described in the Error Handling section.
Example

curl -X DELETE \  
-v http://api.backendless.com/XXXX-XXXX-XXXX/ZZZZ-ZZZZ-ZZZZ/geo/categories/foobarcategory