Skip to main content
DELETE
/
v1
/
teams
/
{teamId}
deleteTeam
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.teams.deleteTeam({
    newDefaultTeamId: "team_LLHUOMOoDlqOp8wPE4kFo9pE",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {},
  });

  console.log(result);
}

run();
{
  "id": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
  "newDefaultTeamIdError": true
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

teamId
string
required

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

Query Parameters

newDefaultTeamId
string

Id of the team to be set as the new default team

Example:

"team_LLHUOMOoDlqOp8wPE4kFo9pE"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
reasons
object[]

Optional array of objects that describe the reason why the team is being deleted.

Response

The Team was successfully deleted

The Team was successfully deleted

id
string
required

The ID of the deleted Team

Example:

"team_LLHUOMOoDlqOp8wPE4kFo9pE"

newDefaultTeamIdError
boolean

Signifies whether the default team update has failed, when newDefaultTeamId is provided in request query.

Example:

true