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

put

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.

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

Possible values:

Responses

200

OK

application/json

400

Bad request

401

Unauthorized

application/json

403

Forbidden

application/json

404

Driver Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /v3/drivekit/admin/drivers/{userId}/status HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "ENABLE"
}

Activate userDeactivate user

{
  "status": "ENABLE"
}

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