Method: providers.vehicles.update
Stay organized with collections
Save and categorize content based on your preferences.
Writes updated vehicle data to the Fleet Engine.
When updating a Vehicle
, the following fields cannot be updated since they are managed by the server:
currentTrips
availableCapacity
currentRouteSegmentVersion
waypointsVersion
The vehicle name
also cannot be updated.
If the attributes
field is updated, all the vehicle's attributes are replaced with the attributes provided in the request. If you want to update only some attributes, see the vehicles.updateAttributes
method. Likewise, the waypoints
field can be updated, but must contain all the waypoints currently on the vehicle, and no other waypoints.
HTTP request
PUT https://fleetengine.googleapis.com/v1/{name=providers/*/vehicles/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. Must be in the format providers/{provider}/vehicles/{vehicle} . The {provider} must be the Project ID (for example, sample-cloud-project ) of the Google Cloud Project of which the service account making this call is a member.
|
Query parameters
Parameters |
header |
object (RequestHeader )
The standard Fleet Engine request header.
|
updateMask |
string (FieldMask format)
Required. A field mask indicating which fields of the Vehicle to update. At least one field name must be provided. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .
|
Request body
The request body contains an instance of Vehicle
.
Response body
If successful, the response body contains an instance of Vehicle
.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003eUpdates vehicle data in Fleet Engine, replacing existing data with the provided information.\u003c/p\u003e\n"],["\u003cp\u003eCertain fields like \u003ccode\u003ecurrentTrips\u003c/code\u003e, \u003ccode\u003eavailableCapacity\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e cannot be updated using this method.\u003c/p\u003e\n"],["\u003cp\u003eWhen updating \u003ccode\u003eattributes\u003c/code\u003e or \u003ccode\u003ewaypoints\u003c/code\u003e, the entire field is replaced; use \u003ccode\u003evehicles.updateAttributes\u003c/code\u003e for partial attribute updates.\u003c/p\u003e\n"],["\u003cp\u003eThe request must specify the vehicle's provider and ID, along with a field mask indicating the fields to be updated.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the updated \u003ccode\u003eVehicle\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,["# Method: providers.vehicles.update\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n\nWrites updated vehicle data to the Fleet Engine.\n\nWhen updating a `Vehicle`, the following fields cannot be updated since they are managed by the server:\n\n- `currentTrips`\n- `availableCapacity`\n- `currentRouteSegmentVersion`\n- `waypointsVersion`\n\nThe vehicle `name` also cannot be updated.\n\nIf the `attributes` field is updated, **all** the vehicle's attributes are replaced with the attributes provided in the request. If you want to update only some attributes, see the `vehicles.updateAttributes` method. Likewise, the `waypoints` field can be updated, but must contain all the waypoints currently on the vehicle, and no other waypoints.\n\n### HTTP request\n\n`PUT https://fleetengine.googleapis.com/v1/{name=providers/*/vehicles/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Must be in the format `providers/{provider}/vehicles/{vehicle}`. The {provider} must be the Project ID (for example, `sample-cloud-project`) of the Google Cloud Project of which the service account making this call is a member. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `header` | `object (`[RequestHeader](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/RequestHeader)`)` The standard Fleet Engine request header. |\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. A field mask indicating which fields of the `Vehicle` to update. At least one field name must be provided. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Vehicle](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/providers.vehicles#Vehicle).\n\n### Response body\n\nIf successful, the response body contains an instance of [Vehicle](/maps/documentation/mobility/fleet-engine/reference/trips/rest/v1/providers.vehicles#Vehicle)."]]