Create a new asset.

post

https://api.samsara.com/assets

Create a new asset.

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

To use this endpoint, select Write Assets under the Assets 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.

Body Params

externalIds

object

A map of external ids

licensePlate

string

The license plate of the asset.

make

string

The OEM/manufacturer of the asset. Updates to this field are restricted.

model

string

The model of the asset. Updates to this field are restricted.

name

string

The human-readable name of the asset. 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 asset. Can be set or updated through the Samsara Dashboard or the API at any time.

readingsIngestionEnabled

boolean

Indicates whether the asset is expected to have data ingested using the Readings API.

regulationMode

string

enum

Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: mixed, regulated, unregulated

Allowed:

serialNumber

string

The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths.

type

string

enum

Defaults to uncategorized

The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: uncategorized, trailer, equipment, unpowered, vehicle

Allowed:

vin

string

The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset.

year

int64

The model year of the asset. Updates to this field are restricted.

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.