Enable or disable a team

This service can be used to enable or disable the analytics services for all the users of a team belonging to your organisation.

When a team is created, its default status is active.

When a team is deactivated, all its API keys are invalidated. As a result:

• The DriveKit trip analysis services are disabled and the SDK will stop running.

• The DriveKit Admin services are disabled and related services can no longer be used.

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

Enable or disable a team

PUThttps://service.drivequant.com/v1/enterprise/teams/{teamId}/status

Path parameters

teamId*string

Unique identifier of the team (url-encoded)

Header parameters

Body

application/json

status*enum

Desired team status

ENABLEDDISABLED

Response

200401404409

OK

Body

application/json

status*enum

Team status

ENABLEDDISABLED

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v1/enterprise/teams/{teamId}/status', {
    method: 'PUT',
    headers: {
      "x-dq-enterprise-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "ENABLED"
    }),
});
const data = await response.json();

Response

200404409

{
  "status": "ENABLED"
}

Request body

Name	Type	Description
status	string	Status of the team Allowed values: ENABLED, DISABLED

Response

The table below summarizes the response parameters.

Name	Type	Description
status	string	Status of the team Allowed values: ENABLED, DISABLED

To enable or disable individual users, you can use the corresponding DriveKit Admin service: https://docs.drivequant.com/backend/driver/status