Patch a team

PATCH 
/v1/teams/:name

This route allows you to patch a team's details. This can be used to update the team's name, users, and description.

To learn more about teams, check out the documentation.

Request

Path Parameters

name stringrequired

The name of the team you want to patch.

application/json

Body

namestring

The new name of the team.


usersstring[]

One or more e-mail addresses of users to add to the new team. This will override the existing user list.


descriptionstring

The new description of the team.

Responses

200

Updated successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

team

object

required

idstring

namestring

createdAtdate-time

updatedAtdate-time

providerstring

descriptionstring

users

object[]

Array [

emailstring

firstNamestring

lastNamestring

picturestring

statusstring

]

Example (from schema)

{
  "ok": true,
  "team": {
    "id": "string",
    "name": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "provider": "string",
    "description": "string",
    "users": [
      {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "picture": "string",
        "status": "string"
      }
    ]
  }
}