Change customer secret

Service version: 1
Last edit: 2022.07.21

Purpose

This endpoint is used to update a secret using an old secret. If an old customer secret needs to be changed, use this endpoint to do it.

Request data

HTTPS method: POST

Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

POST
Request URL
https://{baseURL}/locationHistory/1/updateSecret?key={Your_API_Key}

curl command format

POST
Request curl command
1curl -XPOST 'Content-type: application/json" -d
2'{
3 "secret": "Enter an old_secret",
4 "newSecret": "Enter a new_secret"
5 }'
6'https://{baseURL}/locationHistory/1/updateSecret?key={Your_API_Key}'

POST request body

POST
POST request body
1{
2 "secret": "Enter an old_secret",
3 "newSecret": "Enter a new_secret"
4}

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 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 valid API Key.

Response data

Response body

Response body - JSON
1{
2 "adminKey": "admin_key_string"
3}

Response fields

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

Primary fieldsDescription
adminKey
string
A generated Admin Key that can be used to manage location history objects.

Response codes

CodeMeaning & possible causes
200OK:
  • Configuration registered.
  • Admin Key regenerated.
204No content: Secret has been replaced with new secret.
400Bad request: Missing or invalid request data.
401Unauthorized: Provided secret is invalid.
403Forbidden: Each customer can register only one configuration.

Example

Update a secret using an old secret

Request URL

POST
Request URL example
https://api.tomtom.com/locationHistory/1/updateSecret?key={Your_API_Key}

POST body format

POST
POST body format
1{
2 "secret": "My very secret secret",
3 "newSecret": "My very secret newSecret"
4}

Response body

Response body - JSON
1{
2 "adminKey": "admin_key_string"
3}