Skip to main content
POST
Save vehicle

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for saving a vehicle with license plate information.

alert
boolean | null

Whether to alert when this vehicle is detected

createdAtMillis
integer<int64> | null
int64

Creation timestamp in milliseconds

Example:

1640995200000

description
string | null

Description of the vehicle

Example:

"Blue Honda Civic"

name
string | null

Name for the vehicle

Example:

"John's Car"

thumbnailS3Key
string | null

S3 key for the vehicle thumbnail image

trust
boolean | null

Whether this vehicle is trusted

vehicleLicensePlate
string | null

License plate number of the vehicle

Example:

"ABC123"

Response

200 - application/json

OK

Response object for saving a vehicle.

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on August 22, 2026