Skip to main content
POST
/
v1
/
vehicles
/
{vehicle_id}
/
listening
Set Vehicle Listening State
curl --request POST \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/listening \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isListening": true
}
'
{
  "vehicleId": "<string>",
  "isListening": true,
  "lastUpdated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
vehicle_id
string
required

Unique internal identifier for the vehicle.

Body

application/json
​
isListening
boolean
required

Indicates whether the vehicle should be marked as listening for data.

Response

202 - application/json

Successful Response

​
vehicleId
string
required

Unique identifier of the vehicle.

​
isListening
boolean
required

Reflects the requested listening state.

​
lastUpdated
string<date-time>
required

Timestamp (UTC) representing when the listening state was last updated.