v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Update an existing asset

put/v1/assets/{id}

Path parameters

idinteger required

Enter the ID of the asset for which you want to update the data.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Request body

statusstring

Specify the status of the asset. Allowed values are Active or Deactivated.

leasedboolean

Specify if the assets are leased or not. TRUE: The asset is leased. FALSE: The asset is not leased.

asset_gateway_idinteger

Specify the ID of the asset gateway to which the asset is linked to.

vinstring

Specify the VIN number of the asset.

Response

200

Example response

{
  "assets": [
    {
      "asset": {
        "id": 635,
        "name": "def",
        "status": "active",
        "type": "low_boy",
        "make": "HYUNDAI MOTOR CO LTD",
        "model": "ZAKLAD BUDOWY I REMONTOW NACZEP WIE",
        "year": "2013",
        "asset_gateway": {
          "id": 698,
          "identifier": "ATE-3NG-DDQ",
          "active": true
        },
        "availability_details": {
          "availability_status": "out_of_service",
          "out_of_service_reason": "Asset Maintenance",
          "updated_at": "2024-07-31T05:30:53Z",
          "additional_note": "This asset sheduled for maintenance",
          "custom_driver_app_warning_prompt": "This asset is scheduled for maintenance, please don't operate",
          "updated_by_user": {
            "id": 123,
            "first_name": "First",
            "last_name": "Last",
            "user_name": "demo_dispatcher",
            "email": "demo.dispatcher@gmail.com",
            "company_reference_id": 1234,
            "status": "active",
            "role": "dispatcher"
          }
        }
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 2
  }
}