v13

OpenAPI 3.0.32026-07-31359869.4 MB

teams

Update a Team Member

Update the membership of a Team Member on the Team specified by teamId, such as changing the role of the member, or confirming a request to join the Team for an unconfirmed member. The authenticated user must be an OWNER of the Team.

patch/v1/teams/{teamId}/members/{uid}

Path parameters

uidstring required

The ID of the member.

Example:ndfasllgPyCtREAqxxdyFKb

The ID of the member.

teamIdstring required

The unique team identifier

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

Request body

confirmedtrue

Accept a user who requested access to the team.

rolestring

The role in the team of the member.

teamPermissionsstring[]

The team permissions to set for the member. Permissions must be compatible with the team roles assigned to the member.

Example request

{
  "confirmed": true,
  "role": "VIEWER",
  "teamPermissions": [
    "CreateProject",
    "FullProductionDeployment"
  ],
  "projects": [
    {
      "projectId": "prj_ndlgr43fadlPyCtREAqxxdyFK",
      "role": "ADMIN"
    }
  ]
}

Response

Successfully updated the membership.

idstring required

ID of the team.