GuidesAPI Reference
API Reference

Updates a device shadow

Updates the trackingId device desired shadow.

The device shadow consists of reported and desired shadows. Only the desired shadow can be updated via this endpoint. The reported shadow is updated automatically when the device sends telemetry to the ingestion endpoint.

Path Params
string
required
length between 1 and 50

This is a unique ID associated with the device data in HERE Tracking. The trackingId gets assigned to a device when the device is claimed by a user.

Query Params
string
length ≥ 8

Application identifier. Used together with an external ID to identify a virtual device.

Body Params
desired
object
required

The desired shadow of the device.

Headers
number
required
0 to 1000

The size of the shadow in bytes. The size is validated against the maximum limit of 1000 bytes.

uuid

ID used for correlating requests within HERE Tracking. Used for logging and error reporting.

Must be a valid UUIDv4.

Responses

404

Not found. Shadow doesn't exist.

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json