Set new settings values

Service version: 1
Last edit: 2022.07.21

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 format

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

curl command format

POST
Request curl command
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

POST
POST request body
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.

Required parametersDescription
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 API Key
adminKey
string
An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.

Response data

Response body

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

Response body - JSON
1{
2 "consentForStoringObjectsPositionsHistory": true/false
3}

Response fields

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

Primary fieldsDescription
consentForStoringObjectsPositionsHistory
boolean
Setting that allows the service to store sensitive, historical objects data in the Geofencing service. This field is shared between the Geofencing and Location History APIs.

Response codes

CodeMeaning & possible causes
200OK
400Bad Request: No setting has been provided.
403Forbidden:
  • Provided Admin Key is invalid.
  • Admin Key missing.

Example

Set a new setting.

Request URL

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

POST request body

POST
POST request body - JSON
1{
2 "consentForStoringObjectsPositionsHistory": true
3}

Response body

Successful response - JSON
1{
2 "consentForStoringObjectsPositionsHistory": true
3}