v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Teams

Update Team

Updates the properties of an existing team, such as its name or type. With user permissions, the team must be one the requesting user has edit access to. With admin permissions, any team belonging to the account can be updated.

patch/v1/teams/{id}

Path parameters

idnumber required

ID of the team to update.

Headers

Lucid-Request-Asstring

If the requesting user is an account owner, team admin, or team manager with the required permissions and they make the request with the value of “admin” as this header and include an admin scope, the request will be made using their admin permissions.

Request body

namestring required

The team's name. Max length of name is 80 characters.

Example request

{
  "name": "Team Name"
}

Response

OK. Returns a Team resource containing information about the updated team.

idnumber

The unique ID for the team.

namestring

The team's name.

type'hidden' | 'closed' | 'open'

The type of the team

createdstring date-time

Date and time when the team was created.

archivedstring date-time nullable

Date and time when the team was archived (if it has been archived).

Example response

{
  "id": 123456789,
  "name": "Team Name",
  "type": "open",
  "created": "2024-01-30T16:29:37Z"
}