Skip to main content

Stop Data Sharing

Description

This API stops vehicle data sharing.

  • Stop data sharing for vehicles requested via parameters, among those vehicles that have given agreement via Select Vehicles.
  • If the vin query parameter is not present, data sharing will be stopped for all vehicles that are sharing data with the brand specified in the header parameter.

Endpoint

DELETE https://api.pleos.ai/v1/vehicles/consent?vin={vin}

Request

curl
curl -X DELETE "https://api.pleos.ai/v1/vehicles/consent?vin={vin}" \
-H "Authorization: Bearer <your_access_token>" \
-H "Content-Type: application/json" \
-H "Brand: hyundai"

Header Params

ParameterTypeDescriptionRequired
AuthorizationstringAccess tokenRequired
Content-Typestringapplication/jsonOptional
BrandstringVehicle brand (hyundai/kia/genesis)Required

Query Params

ParameterTypeDescriptionRequired
vinstringVINOptional

Response

Success

200
{
"data": {},
"meta": {
"code": 200,
"message": "Success",
"success": "true",
"timestamp": "2025-09-01T11:00:00Z",
"requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
}
}

Failure

4002
{
"error": {
"code": "4002",
"message": "Invalid request parameters",
"details": [],
"timestamp": "2025-09-01T12:00:00Z",
"requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
}
}
[Error Code]

For detailed information about error code on failure, see Error Code.