Clear notifications history
Service version: 1
Last edit: 2020.05.21
On this page
Purpose
This endpoint clears the history of sent notifications.
Request data
HTTPS 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.
https://baseURL/notifications/versionNumber/history?key=Your_API_Key
curl command
curl -XDELETE 'https://baseURL/notifications/versionNumber/history?key=Your_API_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. Value: 1 |
key string |
An API Key valid for the requested service. Value: Your valid API Key . |
Optional parameters | |
This endpoint does not have any optional parameters. |
Response data
Response body
{
"deleteAllHistoryMessagesBefore": "ISO8601_timestamp",
"deleteAllHistoryMessagesBeforeStatus": "status"
}
Response fields
The following table describes all of the fields that can appear in a Response.
Primary fields | |
---|---|
Field | Description |
deleteAllHistoryMessagesBefore string |
Timestamp (ISO 8601 format) marking the moment before the history will be deleted. |
deleteAllHistoryMessagesBeforeStatus string |
Status of the deletion process. Live status can be checked in the current options list. Value: PROCESSING |
HTTP Response codes
Code | Meaning and possible causes |
---|---|
200 |
OK: Deletion of history has begun. |
Examples
HTTP Method: DELETE
https://api.tomtom.com/notifications/1/history?key=Your_API_Key
Response body
{
"deleteAllHistoryMessagesBefore": "2019-08-12T08:32:20.843Z",
"deleteAllHistoryMessagesBeforeStatus": "PROCESSING"
}