Skip to main content
POST
Create vehicle

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

Body

application/json
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

external_id
string | null

An optional external identifier for the vehicle. If provided and a vehicle with this external_id already exists, the existing vehicle will be updated instead of creating a new one.

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
default:false

Whether this should be the primary vehicle. If true, any existing primary vehicle will be demoted.

Response

Existing vehicle with matching external_id was updated

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