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.

PUThttps://service.drivequant.com/v3/drivekit/admin/drivers/{userId}/status

Path parameters

userId*string

User unique identifier

Header parameters

Body

application/json

status*enum

Status of the driver after the update

ENABLEDISABLE

Response

200400401403404

OK

Body

application/json

status*enum

Status of the driver after the update

ENABLEDISABLE

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v3/drivekit/admin/drivers/{userId}/status', {
    method: 'PUT',
    headers: {
      "DriveKit-Admin-API-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "ENABLE"
    }),
});
const data = await response.json();

Response

200401403404

{
  "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