SAsamsara
Beta APIs

[beta] Update an equipment

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

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Equipment under the Equipment category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

patch/beta/fleet/equipment/{id}

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

idstring required

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

Request body

engineHoursinteger

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

equipmentSerialNumberstring

The serial number of the equipment.

externalIdsobject

A map of external ids

idstring

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

namestring

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.

notesstring

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.

odometerMetersinteger

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

tagIdsstring[]

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.

Example request

{
  "attributes": [
    {
      "dateValues": [
        "2024-01-15",
        "2024-12-31"
      ],
      "id": "494123",
      "name": "Compliance/ELD",
      "numberValues": [
        867,
        5309
      ],
      "stringValues": [
        "HQ",
        "Leased"
      ]
    }
  ],
  "engineHours": 1234,
  "equipmentSerialNumber": "8V8WD530FLN016251",
  "id": "494123",
  "name": "Equipment-123",
  "notes": "These are my equipment notes",
  "odometerMeters": 1234,
  "tagIds": [
    "Ducimus voluptates alias qui voluptate in.",
    "Et autem et quia placeat."
  ]
}

Response

OK response.

Example response

{
  "data": {
    "attributes": [
      {
        "dateValues": [
          "2024-01-15",
          "2024-12-31"
        ],
        "id": "494123",
        "name": "Compliance/ELD",
        "numberValues": [
          867,
          5309
        ],
        "stringValues": [
          "HQ",
          "Leased"
        ]
      }
    ],
    "equipmentSerialNumber": "8V8WD530FLN016251",
    "id": "494123",
    "installedGateway": {
      "model": "VG34",
      "serial": "GFRV-43N-VGX"
    },
    "name": "Equipment-123",
    "notes": "These are my equipment notes",
    "tags": [
      {
        "id": "3914",
        "name": "East Coast",
        "parentTagId": "4815"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.