Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Users

Update team

Replace the team definition. Use GET to fetch current data if you intend to add fields without overwriting existing values.

patch/console/v1/users/teams/{id}

Path parameters

idstring required

id

Request body

namestring

The name of the team.

descriptionstring

Description of the team.

idstring

The ID of the team.

membersstring[]

Array of member email addresses in the team.

adminsstring[]

Array of admin email addresses in the team.

changeTeamConfigs'anyone' | 'team_only'

Who can change team configurations: "anyone" or "team_only".

reviewApproval'anyone' | 'team_only' | 'admin_only'

Who can review and approve changes: "anyone", "team_only", or "admin_only".

defaultTargetApplicationsstring[]

Default target applications for the team.

defaultHoldoutIDstring nullable

Default holdout ID for the team, if applicable.

requireReviewsboolean nullable

Whether reviews are required for changes, if applicable.

requireGateTemplatesboolean nullable

Whether gate templates are required for the team, if applicable.

requireExperimentTemplatesboolean nullable

Whether experiment templates are required for the team, if applicable.

requireDynamicConfigTemplatesboolean nullable

Whether dynamic config templates are required for the team, if applicable.

Response

Update team response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Team updated successfully.",
  "data": {
    "name": "The Avengers",
    "members": [
      {
        "userID": "5sgBiiuoBX4fscrWdCXVma",
        "email": "test@statsig.com",
        "firstName": "test",
        "lastName": "user",
        "role": "admin"
      }
    ],
    "admins": [],
    "defaultGateMetrics": [
      {
        "name": "A metric for asd ",
        "type": "event_count_custom"
      }
    ],
    "defaultExperimentPrimaryMetrics": [
      {
        "name": "A metric for aaaa ",
        "type": "event_count_custom"
      }
    ],
    "defaultExperimentSecondaryMetrics": [],
    "defaultHoldoutMetrics": [],
    "changeTeamConfigs": "anyone",
    "reviewApproval": "anyone",
    "defaultTargetApplications": [
      "Android"
    ]
  }
}