Edit object

Purpose

This endpoint provides new values for an existing object's attributes. An Admin may only send the values that need to be updated.

Request data

HTTPS method: PUT

• 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}/objects/{objectId}?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

1curl -XPUT "Content-type: application/json" -d
2'{
3   "name": "object_name",
4   "properties": {
5     "key": "value"
6     ...
7   }
8 }'
9'https://{baseURL}/locationHistory/{versionNumber}/objects/{objectId}?key={Your_API_Key}&adminKey={Your_Admin_Key}'

PUT request body format

1{
2  "name": "object_name",
3  "properties": {
4    "key": "value"
5  }
6}

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.

Response data

Response body

1{
2  "name": "object_name",
3  "id": "object_id",
4  "properties": {
5    "key": "value"
6  }
7}

Response fields

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

Response codes

Example

Edit an object.

URL request example

https://api.tomtom.com/locationHistory/1/objects/b3e6a642-e082-499e-8e04-dee9e5e9c575?key={Your_API_Key{&adminKey={Your_Admin_Key}

PUT request body example

1{
2  "properties": {
3    "embeddedId": "EL 11111"
4  }
5}

Response body example

1{
2  "name": "Support car 1",
3  "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d",
4  "properties": {
5    "embeddedId": "EL 11111"
6  }
7}