Skip to main content
PUT
/
teams
/
{team_token}
Update team
curl --request PUT \
  --url https://api.vantage.sh/v2/teams/{team_token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "workspace_tokens": [
    "<string>"
  ],
  "user_tokens": [
    "<string>"
  ],
  "user_emails": [
    "<string>"
  ],
  "role": "owner",
  "default_dashboard_token": "<string>"
}
'
{
  "token": "team_d617e73dcc6b57c5",
  "name": "Updated Team",
  "description": "Updated Team Description",
  "workspace_tokens": [
    "wrkspc_efc4284a56772481"
  ],
  "user_tokens": [
    "usr_d268561e520c7aac"
  ],
  "default_dashboard_token": null
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
team_token
string
required

Body

application/json

Update a Team.

​
name
string

The name of the Team.

​
description
string

The description of the Team.

​
workspace_tokens
string[]

The Workspace tokens to associate to the Team.

​
user_tokens
string[]

The User tokens to associate to the Team.

​
user_emails
string[]

The User emails to associate to the Team.

​
role
enum<string>

The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.

Available options:
owner,
editor,
viewer
​
default_dashboard_token
string | null

The token of a Dashboard to set as the Team default. Send null to clear.

Response

Team model

​
token
string
required
​
name
string
required

The name of the Team.

Example:

"Cost Savers"

​
description
string | null
required

The description of the Team.

Example:

"The Team that saves costs"

​
workspace_tokens
string[]
required

The tokens for any Workspaces that the Team belongs to

​
user_emails
string[]
required

The email addresses for Users that belong to the Team

​
user_tokens
string[]
required

The tokens for Users that belong to the Team

​
default_dashboard_token
string | null
required

The token of the default Dashboard for the Team.

Example:

"dshbrd_abcd1234"