v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Vehicles

Update a vehicle

Required scope: vehicles:write

patch/api/v1/vehicles/{vehicleId}

Path parameters

vehicleIdinteger required

Request body

namestring nullable

Name of the vehicle

modelIdinteger nullable

Id of the vehicle model. Omit or leave null to keep the existing value.

teamIdinteger nullable

Id of the team the vehicle belongs to

licensePlatestring nullable

License plate of the vehicle

brandstring nullable

Manual vehicle brand name.

modelNamestring nullable

Manual vehicle model name.

vehicleTypestring nullable

Vehicle type.

vidstring nullable

VID identifier for auto-charge (manual vehicles only). Format: VID:xxxxxxxxxxxx

Example request

{
  "name": "Viking Bus 42",
  "modelId": 1234,
  "teamId": 100,
  "licensePlate": "AB12345",
  "brand": "Volvo",
  "modelName": "FH Electric",
  "vehicleType": "truck",
  "vid": "VID:001681036794"
}

Response

Vehicle updated

idinteger

Id of the vehicle

teamIdinteger nullable

Team Id that the vehicle belongs to

userIdinteger nullable

User Id that the vehicle belongs to

namestring nullable

Name of the vehicle, can be customized by the user

licensePlatestring nullable

License plate of the vehicle

batteryCapacityKwhnumber double nullable

Battery capacity of the vehicle in Kwh

maxPowerKwAcnumber double nullable

Maximum AC charging power (in kW) that the vehicle can accept when charging via an AC charger

maxPowerKwDcnumber double nullable

Maximum DC charging power (in kW) that the vehicle can accept when using a DC fast charger

displayNamestring nullable

Display name of the vehicle

integrationIdinteger nullable

Id of the vehicle integration

integrationStatusstring nullable

Status of the vehicle integration

manuallyConfiguredAtstring date-time nullable

Timestamp when the vehicle was manually configured (null if using catalog model)

vidstring nullable

VID identifier for auto-charge

Example response

{
  "id": 1,
  "teamId": 2,
  "userId": 3,
  "name": "Tesla",
  "licensePlate": "CT88585",
  "batteryCapacityKwh": 85,
  "maxPowerKwAc": 29,
  "maxPowerKwDc": 35.5,
  "displayName": "Tesla Model 3 Performance (2021) - 72 kWh",
  "integrationId": 89188,
  "integrationStatus": "connected",
  "customSpecification": {
    "brand": "Volvo",
    "model": "FH Electric",
    "vehicleType": "truck"
  },
  "vid": "VID:001681036794"
}