[beta] Update an equipment

patch

https://api.samsara.com/beta/fleet/equipment/{id}

Update an equipment. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Equipment under the Equipment category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.

Body Params

attributes

array of objects

List of attributes associated with the entity

attributes

engineHours

int64

When you provide a manual engine hours override, Samsara will begin updating a equipment's engine hours used since this override was set.

equipmentSerialNumber

string

The serial number of the equipment.

externalIds

object

A map of external ids

string

The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.

name

string

The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.

notes

string

length ≤ 255

These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.

odometerMeters

int64

When you provide a manual odometer override, Samsara will begin updating a equipment's odometer using GPS distance traveled since this override was set.

tagIds

array of strings

An array of IDs of tags to associate with this equipment. If your access to the API is scoped by one or more tags, this field is required to pass in.

tagIds

Responses

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.