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

put

/teams/{teamId}/status

Path parameters

teamIdstringrequired

Unique identifier of the team (url-encoded)

Header parameters

x-dq-enterprise-api-keystringrequired

Enterprise API key

Body

statusstring · enumrequired

Desired team status

Options: ENABLED, DISABLED

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://service.drivequant.com/v1/enterprise/teams/{teamId}/status' \
  --header 'x-dq-enterprise-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"status":"ENABLED"}'

200

401

404

409

200

Team disabled

Team enabled

Team disabled

{
  "status": "DISABLED"
}

OK

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