teams

Join a team

Changed on

Join a team with a provided invite code or team ID.

post/v1/teams/{teamId}/members/teams/join

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/teams/{teamId}/members/teams/join
  • Auth: HTTP bearer

Path parameters

teamIdstring required

The unique team identifier

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

Request body

inviteCodestring

The invite code to join the team.

Example request

{
  "inviteCode": "fisdh38aejkeivn34nslfore9vjtn4ls"
}

Response

Successfully joined a team.

fromstring required

The origin of how the user joined.

namestring required

The name of the team the user joined.

slugstring required

The slug of the team the user joined.

teamIdstring required

The ID of the team the user joined.

Example response

{
  "from": "email",
  "name": "My Team",
  "slug": "my-team",
  "teamId": "team_LLHUOMOoDlqOp8wPE4kFo9pE"
}

Changes