---
title: "[beta] Update an equipment"
method: PATCH
path: "/beta/fleet/equipment/{id}"
tags: ["Beta APIs"]
---

# \[beta\] Update an equipment

`PATCH /beta/fleet/equipment/{id}`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/beta/fleet/equipment/{id}`
- Auth: HTTP bearer

Update an equipment.  **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) 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.

## Path parameters

- `id` string, required

## Request body

- EquipmentPatchEquipmentRequestBody
  - `attributes` GoaAttributeTiny[]: List of attributes associated with the entity
    - `dateValues` string[]: List of date values associated with the attribute (RFC 3339 full-date format: YYYY-MM-DD).
    - `id` string: Id of the attribute
    - `name` string: Name of the attribute
    - `numberValues` number[]: List of number values associated with the attribute
    - `stringValues` string[]: List of string values associated with the attribute.
  - `engineHours` integer: 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
  - `id` 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: 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` integer: 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` string[]: 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.

## Response `200`

OK response.

- EquipmentPatchEquipmentResponseBody
  - `data` EquipmentWithAttributesResponseObjectResponseBody, required: The equipment object.
    - `attributes` GoaAttributeTinyResponseBody[]: List of attributes associated with the entity
      - `dateValues` string[]: List of date values associated with the attribute (RFC 3339 full-date format: YYYY-MM-DD).
      - `id` string: Id of the attribute
      - `name` string: Name of the attribute
      - `numberValues` number[]: List of number values associated with the attribute
      - `stringValues` string[]: List of string values associated with the attribute.
    - `equipmentSerialNumber` string: The serial number of the equipment.
    - `externalIds` object: A map of external ids
    - `id` string: The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.
    - `installedGateway` GoaGatewayTinyResponseResponseBody: A minified gateway object
      - `model` 'AG15' | 'AG24' | 'AG24EU' | 'AG26' | 'AG26EU' | 'AG41' | 'AG41EU' | 'AG45' | 'AG45EU' | 'AG46' | 'AG46EU' | 'AG46P' | 'AG46PEU' | 'AG51' | 'AG51EU' | 'AG52' | 'AG52EU' | 'AG53' | 'AG53EU' | 'AT11' | 'AT11X' | 'AT12' | 'AT12X' | 'AT13' | 'IG15' | 'IG21' | 'IG41' | 'IG61' | 'SG1' | 'SG1B' | 'SG1G' | 'SG1G32' | 'SG1x' | 'VG32' | 'VG33' | 'VG34' | 'VG34EU' | 'VG34FN' | 'VG34M' | 'VG54ATT' | 'VG54EU' | 'VG54FN' | 'VG54NA' | 'VG54NAE' | 'VG54NAH' | 'VG55EU' | 'VG55FN' | 'VG55NA', required: The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `AT11`, `AT11X`, `AT12`, `AT12X`, `AT13`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`
      - `serial` string, required: The serial number of the gateway installed on the asset.
    - `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: 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.
    - `tags` GoaTagTinyResponseResponseBody[]: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Equipment.
      - `id` string, required: ID of the tag
      - `name` string, required: Name of the tag.
      - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)
