Change customer secret
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
- 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 these values. The generic URL format is as follows.
URL request format
https://{baseURL}/geofencing/{versionNumber}/updateSecret?key={Your_API_Key}
curl command request format
1curl -XPOST 'Content-type: application/json" -d2'{3 "secret": "Enter an old_secret",4 "newSecret": "Enter a new_secret"5 }'6'https://{baseURL}/geofencing/{versionNumber}/updateSecret?key={Your_API_Key}'
POST request body format
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 parameters | Description |
---|---|
| The base URL for calling the API. |
| Service version. |
| An API Key valid for the requested service. |
Response data
Response body
1{2 "adminKey": "admin_key_string"3}
Response fields
The following table describes all of the fields that can appear in a response.
Primary fields | Description |
---|---|
| A generated Admin Key that can be used to manage geofencing objects/fences/projects. |
Response codes
Code | Meaning & possible causes |
---|---|
| OK:
|
| No content: Secret has been replaced with new secret. |
| Bad request: Missing or invalid request data. |
| Unauthorized: Provided secret is invalid. |
| Forbidden: Each customer can register only one configuration. |
Example
Update a secret using an old secret.
HTML Method: POST
https://api.tomtom.com/geolocation/1/updateSecret?key=yPMFGLgBoejrRoWS8qYS
POST body request example
1{2 "secret": "My very secret secret",3 "newSecret": "My very secret newSecret"4}
Response body example
1{2 "adminKey": "admin_key_string"3}