Delete Team

delete

https://api.regal.ai/v1/teams/{teamId}

API Details

Deletes a team. Without force, nothing is deleted while agents (including soft-deleted ones), queues, routing rule sets or linked entities use the team, and the response lists them. With force=true, the team is removed from its agents, and the Twilio workers of the agents are updated, the links to the linked entities are cleared, and the team is deleted. Queues and routing rule sets are never changed: the ones that use the team are returned in unclearedReferences, and their detection is best effort because their expressions are free text.

Rate Limit

Limit Type	Value
Requests per second	10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Responses

400

Invalid team id.

403

The user is not a brand admin.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The team was deleted

404The brand has no team with this id (team_not_found).

409Agents, queues, routing rule sets or linked entities use the team and force is not true (team_in_use). details lists them, up to 25 of each, with the full total.

429Exceeded rate limit.

500The team was deleted, but the Twilio worker of some agents could not be updated (team_agents_sync_failed). The team cannot be deleted again: details lists the agents to repair, up to 25, with the full total. Updating the teams of an agent with the update agent endpoint updates its worker.