Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
mileage
/
vehicles
/
{vehicleId}
/
archive
Archive vehicle
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/mileage/vehicles/{vehicleId}/archive \
  --header 'Authorization: Bearer <token>'
{
  "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

Response

The archived 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