Status

This API allows you to either activate or deactivate a user, by updating their status. A deactivated user will not be able to use DriveQuant services. A deactivated user is not considered as an active user.

If you have your admin API key, you can try the API via this link.

Update a driver's status

This service can be used to update the current status of a user from the userId. Set the status to ENABLE to activate, or DISABLE to deactivate the user.

put

/drivekit/admin/drivers/{userId}/status

Path parameters

userIdstringrequired

User unique identifier

Header parameters

DriveKit-Admin-API-Keystringrequired

Drivekit Admin API key

Body

statusstring · enumrequired

Status of the driver after the update

Options: ENABLE, DISABLE

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://service.drivequant.com/v3/drivekit/admin/drivers/{userId}/status' \
  --header 'DriveKit-Admin-API-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ENABLE"}'

200

400

401

403

404

200

User has been activated

User has been deactivated

User has been activated

{
  "status": "ENABLE"
}

OK

Path parameters

Field	Type	Description
userId	string	Driver's unique identifier

Response

The table below summarizes the body of the response.

Field	Type	Description
status	string	New status of the driver. Allowed values: ENABLE, DISABLE