Skip to main content
PUT
/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}

Authorizations

Authorization
string
header
required

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

Path Parameters

realmId
string
required
organizationId
string
required
vehicleId
string
required

Body

application/json
name
string
required
Required string length: 1 - 256
licensePlate
string
required
Required string length: 1 - 16
make
string
required
Required string length: 1 - 128
model
string
required
Required string length: 1 - 128
year
integer
required
Required range: 1900 <= x <= 2100
shared
object[]
Minimum array length: 1

Response

200 - application/json

Successful response

id
string
required
realmId
string
required
organizationId
string
required
name
string
required
licensePlate
string
required
make
string
required
model
string
required
year
number
required
status
enum<string>
required

Vehicle lifecycle state — archiving is a soft-delete, never a hard removal.

Available options:
ACTIVE,
ARCHIVED
external
object
required

Provider-side identifiers for the vehicle's dedicated gas-card wallet.

createdBy
string
updatedBy
string
createdAt
string
updatedAt
string