Skip to main content
POST
/
v1
/
teams
/
{teamId}
/
members
/
teams
/
join
joinTeam
import { Vercel } from "@vercel/sdk";  const vercel = new Vercel({  bearerToken: "<YOUR_BEARER_TOKEN_HERE>", });  async function run() {  const result = await vercel.teams.joinTeam({  teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",  requestBody: {  inviteCode: "fisdh38aejkeivn34nslfore9vjtn4ls",  },  });   console.log(result); }  run();
{  "teamId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",  "slug": "my-team",  "name": "My Team",  "from": "email" }

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
teamId
string
required

The unique team identifier

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

Body

application/json
​
inviteCode
string

The invite code to join the team.

Example:

"fisdh38aejkeivn34nslfore9vjtn4ls"

Response

Successfully joined a team.

​
teamId
string
required

The ID of the team the user joined.

Example:

"team_LLHUOMOoDlqOp8wPE4kFo9pE"

​
slug
string
required

The slug of the team the user joined.

Example:

"my-team"

​
name
string
required

The name of the team the user joined.

Example:

"My Team"

​
from
string
required

The origin of how the user joined.

Example:

"email"

⌘I