Edit object

This endpoint:

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

HTTPS method: PUT

URL format

For ease of viewing and identification:

• Required constants and parameters are shown in bold text.
• Optional parameters are shown in plain text.

https://baseURL/locationHistory/versionNumber/objects/objectId?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -XPUT "Content-type: application/json" -d
'{
   "name": "object_name",
   "properties": {
     "key": "value"
     ...
   }
 }'
'https://baseURL/locationHistory/versionNumber/objects/objectId?key=Your_API_Key&adminKey=Your_Admin_Key'

PUT request body (JSON)

{
  "name": "object_name",
  "properties": {
    "key": "value"
  }
}

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.

Response body

{
  "name": "object_name",
  "id": "object_id",
  "properties": {
    "key": "value"
  }
}

Response fields

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

▲ Return to top

HTTP response codes

Request URL PUT

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

PUT request body

{
  "properties": {
    "embeddedId": "EL 11111"
  }
}

Response body (JSON)

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