Skip to content
Get started

Add a user to the project

client.projects.memberships.add(stringprojectID, MembershipAddParams { user_id } body, RequestOptionsoptions?): MembershipAddResponse { id, created_at, project, 3 more }
POST/api/projects/{project_id}/memberships/

Memberships for a single project (nested under /api/projects/{project_id}/memberships/).

ParametersExpand Collapse
projectID: string
body: MembershipAddParams { user_id }
user_id: number
ReturnsExpand Collapse
MembershipAddResponse { id, created_at, project, 3 more }
id: string
formatuuid
created_at: string
formatdate-time
project: string
formatuuid
updated_at: string
formatdate-time
user: number
user_email: string
formatemail
Add a user to the project
import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const response = await client.projects.memberships.add('-2fdc-d-d8--bb--3a671d0-3-ae4a0-33c-', {
  user_id: 0,
});

console.log(response.id);
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user": 0,
  "user_email": "dev@stainless.com"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user": 0,
  "user_email": "dev@stainless.com"
}