Skip to main content
POST
Archive a vehicle
The wallet’s available balance goes back to the organization’s default wallet — a blocked or cashback balance stays in it — and the wallet is blocked, so it can no longer pay for anything; the vehicle’s status then becomes ARCHIVED. An archived vehicle is still listed and can still be read, and unarchive reactivates it. No request body. Only organization admins can archive vehicles. If the wallet can’t be emptied or blocked, that error is returned with its own status, code and origin and the vehicle stays ACTIVE; sending the request again is safe.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the vehicle belongs to.

Format: UUID

vehicleId
string
required

ID of the vehicle (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

Successful response

A vehicle of the organization's fleet.

id
string
required

ID of the vehicle.

Example:

"6710b8e4c9e77b0012a4d6f1"

realmId
string<uuid>
required

ID of the realm the vehicle belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId
string<uuid>
required

ID of the organization the vehicle belongs to.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

name
string
required

Display name of the vehicle.

Example:

"Delivery van 07"

licensePlate
string
required

License plate, upper-cased with no hyphen or space: the old Brazilian format (ABC1234) or the Mercosul one (ABC1D23).

Example:

"BRA2E19"

make
string
required

Manufacturer.

Example:

"Fiat"

model
string
required

Model.

Example:

"Fiorino"

year
number
required

Model year.

Example:

2023

status
enum<string>
required

ACTIVE, or ARCHIVED once the vehicle was archived. An archived vehicle's wallet is blocked.

Available options:
ACTIVE,
ARCHIVED
Example:

"ARCHIVED"

external
object
required

The vehicle's dedicated wallet.

customFields
object
required

Values of the organization's vehicle custom fields, keyed by the custom field's slug. Empty when none were set.


Example: {"cost-center":"CC-1020"}

Example:
createdBy
string<uuid>

ID of the user who registered the vehicle.

Example:

"e3553bc1-5e20-4e17-b22a-a796fda0aa99"

updatedBy
string<uuid>

ID of the user who last changed the vehicle.

Example:

"e3553bc1-5e20-4e17-b22a-a796fda0aa99"

createdAt
string<date-time>

When the vehicle was registered.

Example:

"2026-10-17T13:45:12.000Z"

updatedAt
string<date-time>

When the vehicle was last changed.

Example:

"2026-10-17T13:45:12.000Z"