Skip to main content
POST
/
v1
/
projects
/
{idOrName}
/
members
addProjectMember
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projectMembers.addProjectMember({
    idOrName: "prj_pavWOn1iLObbXLRiwVvzmPrTWyTf",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      uid: "ndlgr43fadlPyCtREAqxxdyFK",
      username: "example",
      email: "[email protected]",
      role: "ADMIN",
    },
  });

  console.log(result);
}

run();
{
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The ID or name of the Project.

Example:

"prj_pavWOn1iLObbXLRiwVvzmPrTWyTf"

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
​
uid
string
required

The ID of the team member that should be added to this project.

Maximum string length: 256
Example:

"ndlgr43fadlPyCtREAqxxdyFK"

​
role
enum<string>
required

The project role of the member that will be added.

Available options:
ADMIN,
PROJECT_DEVELOPER,
PROJECT_VIEWER
Example:

"ADMIN"

​
username
string

The username of the team member that should be added to this project.

Maximum string length: 256
Example:

"example"

​
email
string<email>

The email of the team member that should be added to this project.

Example:

"[email protected]"

Response

Responds with the project ID on success.

Responds with the project ID on success.

​
id
string
required