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

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

Possible values:

Responses

200

OK

application/json

statusstring · enumRequired

Team status

Possible values:

401

Unauthorized

404

Not Found

application/json

409

Conflict

application/json

put/teams/{teamId}/status

PUT /v1/enterprise/teams/{teamId}/status HTTP/1.1
Host: service.drivequant.com
x-dq-enterprise-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "ENABLED"
}

{
  "status": "DISABLED"
}

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