Update vehicle

Partially updates a vehicle. Only provided fields will be updated.

PATCH /v1/businesses/{businessId}/mileage/vehicles/{vehicleId}

Update vehicle

cURL

curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/vehicles/{vehicleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "make_and_model": "<string>",
  "year": 123,
  "license_plate": "<string>",
  "vin": "<string>",
  "description": "<string>",
  "is_primary": true
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "make_and_model": "<string>",
  "year": 123,
  "is_primary": true,
  "is_eligible_for_deletion": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "license_plate": "<string>",
  "vin": "<string>",
  "description": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type · string

Content-Type must be set to application/json

Path Parameters

businessId · string<uuid> · required

The UUID of the business

vehicleId · string<uuid> · required

The UUID of the vehicle

Body

application/json

All fields are optional. Only provided fields will be updated.

external_id · string | null

An optional external identifier for the vehicle

make_and_model · string

The make and model of the vehicle

year · integer

The model year of the vehicle

license_plate · string | null

The license plate number of the vehicle

vin · string | null

The Vehicle Identification Number (VIN)

description · string | null

An optional description or notes about the vehicle

is_primary · boolean

Whether this should be the primary vehicle

Response

200

application/json

The updated vehicle

id · string<uuid> · required

The unique identifier of the vehicle

business_id · string<uuid> · required

The UUID of the business this vehicle belongs to

make_and_model · string · required

The make and model of the vehicle (e.g., 'Toyota Camry')

year · integer · required

The model year of the vehicle

is_primary · boolean · required

Whether this is the primary vehicle for the business. Only one vehicle can be primary at a time.

is_eligible_for_deletion · boolean · required

Whether the vehicle can be deleted. A vehicle cannot be deleted if it has trips or is archived.

created_at · string<date-time> · required

Timestamp when the vehicle was created

updated_at · string<date-time> · required

Timestamp when the vehicle was last updated

external_id · string | null

An optional external identifier for the vehicle, used for idempotency

license_plate · string | null

The license plate number of the vehicle

vin · string | null

The Vehicle Identification Number (VIN)

description · string | null

An optional description or notes about the vehicle

archived_at · string<date-time> | null

Timestamp when the vehicle was archived, or null if not archived

deleted_at · string<date-time> | null

Timestamp when the vehicle was deleted, or null if not deleted