Skip to main content
POST
/
teams
/
{team_token}
/
members
Add team member
curl --request POST \
  --url https://api.vantage.sh/v2/teams/{team_token}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_email": "<string>",
  "role": "editor"
}
'
{
  "user_email": "[email protected]",
  "role": "editor"
}

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

Add a member to a Team.

​
user_email
string
required

The email address of the user to add to the Team.

​
role
enum<string>
default:editor
required

The role to assign to the user. Defaults to 'editor'.

Available options:
owner,
editor,
viewer,
integration_owner

Response

TeamMember model

​
name
string
required

The name of the team member.

Example:

"John Doe"

​
email
string
required

The email address of the team member.

Example:

"[email protected]"

​
user_token
string
required

The token of the team member.

Example:

"usr_abcd1234"

​
role
string
required

The role of the team member in the team.

Example:

"editor"