Set new settings values

Purpose

This endpoint is used to change privacy settings.

Request data

HTTPS method: POST

• 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 request format

https://{baseURL}/locationHistory/{versionNumber}/settings?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

1curl -XPOST "Content-type: application/json" -d
2'{
3   "consentForStoringObjectsPositionsHistory": true/false
4 }'
5'https://{baseURL}/locationHistory/{versionNumber}/settings?key={Your_API_Key}&adminKey={Your_Admin_Key}'

POST request body format

1{
2  "consentForStoringObjectsPositionsHistory": true/false
3}

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.

Note: There are no optional parameters in this endpoint.

Response data

Response body

The following JSON code block demonstrates a successful response from the API server.

1{
2  "consentForStoringObjectsPositionsHistory": true/false
3}

Response fields

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

Response codes

Example

Set a new setting.

POST request URL example

https://api.tomtom.com/locationHistory/1/settings?key={Your_API_Key}&adminKey={Your_Admin_Key}

POST request body example

1{
2  "consentForStoringObjectsPositionsHistory": true
3}

Response body example

1{
2  "consentForStoringObjectsPositionsHistory": true
3}