Deactivate a vehicle
PUT/api/vehicles/deactivate/:vehicleId
Deactivate a vehicle of the user. This method should be used to remove a vehicle from a policy. No check-ins are allowed on deactivated vehicles. This method does not check if the vehicle is already deactivated or if there are pending check-ins.
Request
Path Parameters
Header Parameters
Partner Id
Client Id
Client Secret
Responses
- 200
- 401
- 403
- 404
- 500
The deactivated vehicle object.
- application/json
- Schema
- Example (from schema)
Schema
Id of the vehicle
License plate number
Photo of Vehicle
Make of the vehicle
Model of the vehicle
VIN of the vehicle.
2 Letter State Code (eg. AL, CA, CO etc.)
Year vehicle was built.
Time at which vehicle was added to the system
Last updated timestamp
User id of the owner
Phone number of the owner
{
"id": "string",
"license": "string",
"photoUrl": "string",
"make": "string",
"model": "string",
"vin": "string",
"state": "string",
"year": "string",
"dateAdded": "string",
"updated": "string",
"userId": "string",
"customerPhoneNumber": "string",
"active": true
}
Authorization error e.g. due to an invalid or missing API keys.
Forbidden. Possible error codes
-
ERROR_NO_PERMISSIONS_TO_RESOURCE
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}
Vehicle not found or owning User not found. Possible error codes
-
ERROR_USER_NOT_FOUND
-
ERROR_VEHICLE_NOT_FOUND
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}
Internal error. Possible error codes
-
INTERNAL_SERVER_ERROR
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}