Skip to content
Docs

Remove a Team Member

DELhttps://api.vercel.com/v1/teams/{teamId}/members/{uid}
Remove a Team Member from the Team, or dismiss a user that requested access, or leave a team. Directory Sync members can be removed when their directory email is absent or does not match the user's primary or verified secondary emails.
Request
import { Vercel } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.teams.removeTeamMember({
    uid: "ndlgr43fadlPyCtREAqxxdyFK",
    newDefaultTeamId: "team_nllPyCtREAqxxdyFKbbMDlxd",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  });


  console.log(result);
}


run();
Response
{
  "id": "icfg_1234567890"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

uidstringRequired
The user ID of the member.
teamIdstringRequired

Query parameters

newDefaultTeamIdstringOptional
The ID of the team to set as the new default team for the Northstar user.

Response

200Successfully removed a member of the team.
idstringRequired
ID of the team.

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource. Not authorized to update the team.
404Error
410Error
503Error