Sorry, you need to enable JavaScript to visit this website.

Delete object

 

Service version: 1 (Public Preview)
Last edit: 2019.03.27

On this page

Purpose

This endpoint uses a command to delete objects.

Request data

HTTP method: DELETE

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in plain text.
DELETE https://baseURL/geofencing/versionNumber/objects/objectId?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -v -XDELETE -H 'https://baseURL/geofencing/versionNumber/objects/objectId?key=Your_API_Key&adminKey=Your_Admin_Key'

Request parameters

The following table describes the parameters that can be used in a Request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of Request parameters is not important.
Required parameters
Parameter Description
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version number.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your valid API Key.
adminKey
string
An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.
objectId
string
The object id to delete.
Value: UUID
Optional parameters
This endpoint does not have any optional parameters.

▲ Return to top

Response data

Response body

{
  "name": "object_name",
  "id": "object_id"
}

Response fields

The following table describes all of the fields that can appear in a Response.

Primary fields
Field Description
name
string
The name of the object.
id
string
The UUID of the object.

HTTP Response codes

Code Meaning and possible causes
200 Deleted
403 Forbidden:

  • The provided Admin Key is invalid.
  • The Admin Key is missing.
404 Not found: The object with the specified id does not exist.

Examples

Request URL

DELETE https://api.tomtom.com/geofencing/1/objects/cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d?key=Your_API_Key&adminKey=Your_Admin_Key

Response body (JSON)

{
    "name": "Support Car 1",
    "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d"
}

▲ Return to top

You are here