Skip to content
Docs

Adds a new member to a project.

POSThttps://api.vercel.com/v1/projects/{idOrName}/members
Adds a new member to the project.
https://api.vercel.com/v1/projects/{idOrName}/members
const response = await fetch('https://api.vercel.com/v1/projects/idOrName/members?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "uid": "ndlgr43fadlPyCtREAqxxdyFK",
    "username": "example",
    "email": "entity@example.com",
    "role": "ADMIN"
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "id": "icfg_1234567890"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired
The ID or name of the Project.

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Body

application/json
uidstringRequired
The ID of the team member that should be added to this project.
usernamestringOptional
The username of the team member that should be added to this project.
emailstringOptional
The email of the team member that should be added to this project.
rolestringRequired
The project role of the member that will be added.

Response

200Responds with the project ID on success.
idstringRequired

Errors

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