Vehicles
Update a vehicle
Updates a vehicle (send only the fields to change).
vehicles:writevehicles:write- 120/min
- Server annotation: Idempotent
Result
generated from the schema
It is the endpoint for a fleet integration: operational status, license plate, seats, payload, cargo space dimensions and next inspection date. The cost per kilometer and the fixed cost are NOT part of the public contract. Returns the updated vehicle.
Arguments
Vehicle identifier.
Limits: min length 1
Vehicle name.
Limits: min length 2
Vehicle description or notes.
Vehicle status.
Available options: active, maintenance, inactive
Registration number; null clears it.
Number of seats; null clears it.
Limits: min 0
Payload in kilograms; null clears it.
Limits: min 0
Cargo space dimensions.
Show child attributesHide child attributes
Length of the cargo space in cm.
Limits: min 0
Width of the cargo space in cm.
Limits: min 0
Height of the cargo space in cm.
Limits: min 0
Cargo area in m².
Limits: min 0
Collection it belongs to; null removes it from any collection.
Limits: min length 1
Whether the vehicle appears as an assignable resource in the planner.
Date of the next technical inspection, in ISO 8601 with offset; null clears it.
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique vehicle identifier.
Vehicle name.
Operational status: active (available), maintenance (in the workshop) or inactive (out of service).
Available options: active, maintenance, inactive
Registration number; null if not recorded.
Seats, including the driver seat; null if not recorded.
Payload in kilograms; null if not recorded.
Date of the next technical inspection in ISO 8601 UTC; null if not recorded.
Identifier of the collection it belongs to; null if it is in none.
Collection path; null if not applicable.
true if it appears in the planner of the account.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs PATCH /api/v1/vehicles/{vehicleId}.
Related pages
Link to this section: Related pagesVehicles
Update a vehicle
Updates a vehicle (send only the fields to change).
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?