Create Team

POST /console/v1/users/teams

Try it

Create Team

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/users/teams \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "members": [
    "<string>"
  ],
  "admins": [
    "<string>"
  ],
  "defaultGateMetrics": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "defaultExperimentPrimaryMetrics": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "defaultExperimentSecondaryMetrics": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "defaultHoldoutMetrics": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "changeTeamConfigs": "anyone",
  "reviewApproval": "anyone",
  "defaultTargetApplications": [
    "<string>"
  ],
  "description": "<string>",
  "defaultHoldoutID": "<string>",
  "requireReviews": true,
  "requireGateTemplates": true,
  "requireExperimentTemplates": true,
  "requireDynamicConfigTemplates": true
}
'

200

{
  "message": "Team created successfully.",
  "data": {
    "name": "The Avengers",
    "members": [
      {
        "email": "[e-mail]",
        "firstName": "test",
        "lastName": "user",
        "role": "admin"
      }
    ],
    "admins": [],
    "defaultGateMetrics": [],
    "defaultExperimentPrimaryMetrics": [],
    "defaultExperimentSecondaryMetrics": [],
    "defaultHoldoutMetrics": [],
    "changeTeamConfigs": "anyone",
    "reviewApproval": "anyone",
    "defaultTargetApplications": []
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Body

application/json

name · string · required

The name of the team.

members · string[] · required

Array of member email addresses in the team.

admins · string[] · required

Array of admin email addresses in the team.

defaultGateMetrics · object[] · required

Default gate metrics for the team.

Show child attributes

defaultGateMetrics. name · string · required

The name of the metric.

defaultGateMetrics. type · string · required

The type of the metric.

defaultExperimentPrimaryMetrics · object[] · required

Default primary metrics for experiments in the team.

Show child attributes

defaultExperimentPrimaryMetrics. name · string · required

The name of the metric.

defaultExperimentPrimaryMetrics. type · string · required

The type of the metric.

defaultExperimentSecondaryMetrics · object[] · required

Default secondary metrics for experiments in the team.

Show child attributes

defaultExperimentSecondaryMetrics. name · string · required

The name of the metric.

defaultExperimentSecondaryMetrics. type · string · required

The type of the metric.

defaultHoldoutMetrics · object[] · required

Default holdout metrics for the team.

Show child attributes

defaultHoldoutMetrics. name · string · required

The name of the metric.

defaultHoldoutMetrics. type · string · required

The type of the metric.

changeTeamConfigs · enum<string> · required

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

Available options: anyone, team_only

reviewApproval · enum<string> · required

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

Available options: anyone, team_only, admin_only

defaultTargetApplications · string[] · required

Default target applications for the team.

description · string

Description of the team.

defaultHoldoutID · string | null

Default holdout ID for the team, if applicable.

requireReviews · boolean | null

Whether reviews are required for changes, if applicable.

requireGateTemplates · boolean | null

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

requireExperimentTemplates · boolean | null

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

requireDynamicConfigTemplates · boolean | null

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

Response

200

application/json

Create team response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. name · string · required

The name of the team.

data. id · string · required

The ID of the team.

data. defaultGateMetrics · object[] · required

Default gate metrics for the team.

Show child attributes

data.defaultGateMetrics. name · string · required

The name of the metric.

data.defaultGateMetrics. type · string · required

The type of the metric.

data. defaultExperimentPrimaryMetrics · object[] · required

Default primary metrics for experiments in the team.

Show child attributes

data.defaultExperimentPrimaryMetrics. name · string · required

The name of the metric.

data.defaultExperimentPrimaryMetrics. type · string · required

The type of the metric.

data. defaultExperimentSecondaryMetrics · object[] · required

Default secondary metrics for experiments in the team.

Show child attributes

data.defaultExperimentSecondaryMetrics. name · string · required

The name of the metric.

data.defaultExperimentSecondaryMetrics. type · string · required

The type of the metric.

data. defaultHoldoutMetrics · object[] · required

Default holdout metrics for the team.

Show child attributes

data.defaultHoldoutMetrics. name · string · required

The name of the metric.

data.defaultHoldoutMetrics. type · string · required

The type of the metric.

data. changeTeamConfigs · enum<string> · required

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

Available options: anyone, team_only

data. reviewApproval · enum<string> · required

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

Available options: anyone, team_only, admin_only

data. defaultTargetApplications · string[] · required

Default target applications for the team.

data. members · object[] · required

Show child attributes

data.members. email · string<email> · required

The email address of the user.

data.members. firstName · string · required

The user's first name.

data.members. lastName · string · required

The user's last name.

data.members. role · string · required

The user's role, which can be 'Admin', 'Read Only', 'Member', or any custom role name.

data. admins · object[] · required

Show child attributes

data.admins. email · string<email> · required

The email address of the user.

data.admins. firstName · string · required

The user's first name.

data.admins. lastName · string · required

The user's last name.

data.admins. role · string · required

The user's role, which can be 'Admin', 'Read Only', 'Member', or any custom role name.

data. description · string

Description of the team.

data. defaultHoldoutID · string | null

Default holdout ID for the team, if applicable.

data. requireReviews · boolean | null

Whether reviews are required for changes, if applicable.

data. requireGateTemplates · boolean | null

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

data. requireExperimentTemplates · boolean | null

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

data. requireDynamicConfigTemplates · boolean | null

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