Skip to main content
POST
Set Vehicle Listening State

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

The vehicle is already in the requested listening state; no change was made.

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.