Delete or deactivate a team

Operation ID: deleteTeam

Group: People Management › Teams

DELETE /people/teams/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Deletes or deactivates a team. The team is removed, or end-dated when it can't be removed. The outcome field in the response says which.

'deleted' means the team was removed and its direct child teams moved under the deleted team's parent. 'deactivated' means the team couldn't be removed because it has members whose membership has ended, or because it is used in financial transactions. Its endDate was set to the current date instead, and reason says why.

You can't delete a team of type 'psaTeam' here. The request fails with TEAM_IN_USE.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	string · v1	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	The unique identifier of the team you want to delete.

Response

200 Success

Under data (deleteTeamOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the team the call acted on.
`name`	string	yes	The name of the team.
`outcome`	any	yes	What happened to the team. 'deleted' when it was removed. 'deactivated' when something still depends on it, so its end date was set to the date of the request instead. One of: `"deleted"`, `"deactivated"`.
`reason`	string	no	Why the team was deactivated rather than deleted. Absent when outcome is 'deleted'.

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "<name>",
    "outcome": "deleted",
    "reason": "<reason>"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`TEAM_IN_USE`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, TEAM_IN_USE
401 — The request carries no valid access token.
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests from this client address. The response has no body and no Retry-After header.
500 — Internal server error