Update a team

Operation ID: updateTeam

Group: People Management › Teams

Open in the interactive reference

PATCH /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.

Updates a team with the fields you send. A field you leave out keeps its current value.

Use the team's id, not its teamNumber.

No field can be cleared, so an endDate can't be removed once set. Unlike POST people/teams, an update does not check that the name is unique.

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 update.

Request body

Required, application/json: updateTeamInput.

Field Type Required Description
name string no The name of the team.
teamType any no The type of the team. One of: "hrTeam", "psaTeam".
startDate string no The first day the team exists. Use format YYYY-MM-DD.
endDate string no The last day the team exists. Use format YYYY-MM-DD. It may not fall before the team's start date, whether you change that start date in the same request or it is already stored.
parentId string no The identifier of the team to move this one under. It may not be the team itself or one of its descendants. See id on GET people/teams/:id. 
{
  "name": "<name>",
  "teamType": "hrTeam",
  "startDate": "<startDate>",
  "endDate": "<endDate>",
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
PARENT_TEAM_NOT_FOUND 400
PARENT_TEAM_CYCLE 400
INVALID_DATE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses