Delete object
Purpose
This endpoint uses a command to delete objects.
Request data
HTTP method: DELETE
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
URL format
DELETE
Request example
https://{baseURL}/locationHistory/{versionNumber}/objects/{objectId}?key={Your_API_Key}&adminKey={Your_Admin_Key}
curl command format
DELETE
Request curl command
curl -XDELETE 'https://{baseURL}/locationHistory/{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.
- The order of request parameters is not important.
Note: There are no optional parameters in this endpoint.
Required parameters | Description |
---|---|
baseURL string | The base URL for calling the API. Value: api.tomtom.com |
versionNumber string | Service version. 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 |
Response data
Response body
Response body - JSON
1{2 "name": "object_name",3 "id": "object_id"4}
Response fields
The following table describes all of the fields that can appear in a response.
Primary fields | Description |
---|---|
name string | The name of the object. |
id string | The UUID of the object. |
Response codes
Code | Meaning & possible causes |
---|---|
200 | Deleted |
403 | Forbidden:
|
404 | Not found: The object with the specified id does not exist. |
Example
Delete an object.
Request URL
DELETE
Request URL example
https://api.tomtom.com/locationHistory/1/objects/cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d?key={Your_API_Key}&adminKey={Your_Admin_Key}
Response body
Response body - JSON
1{2 "name": "Support Car 1",3 "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d"4}