Create User Project Membership

POST

Creates a membership for a user in a specified project, and assigns the user the appropriate project access based on the specified project security role.

A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest.

Path parameters

projectIdstringRequired

Reference to Project

userIdstringRequired

Reference to User

Headers

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Request

This endpoint expects an object.

roleenumOptional

Allowed values: GuestCollaborateEditorManager

Role to apply

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

dataobjectOptional

A ProjectMember is a user who can collaborate on a Project. You can control permissions for what each ProjectMember can do and how they can interact with the Project using this model.

POST

1 curl -X POST https://api.projectmanager.com/api/data/projects/projectId/members/userId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "error": {
3     "technicalError": "technicalError",
4     "additionalErrors": [
5       "additionalErrors"
6     ],
7     "validationErrors": {
8       "key": [
9         "value"
10       ]
11     },
12     "message": "message"
13   },
14   "success": true,
15   "hasError": true,
16   "statusCode": "Continue",
17   "data": {
18     "id": "id",
19     "initials": "initials",
20     "name": "name",
21     "avatarUrl": "avatarUrl",
22     "permission": "permission",
23     "color": "color",
24     "permissionOptions": {
25       "none": true,
26       "collaborate": true,
27       "guest": true,
28       "editor": true,
29       "manager": true
30     },
31     "role": "role"
32   }
33 }

Update User Project Membership

Up Next

Built with

1	curl -X POST https://api.projectmanager.com/api/data/projects/projectId/members/userId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"error": {
3	"technicalError": "technicalError",
4	"additionalErrors": [
5	"additionalErrors"
6	],
7	"validationErrors": {
8	"key": [
9	"value"
10	]
11	},
12	"message": "message"
13	},
14	"success": true,
15	"hasError": true,
16	"statusCode": "Continue",
17	"data": {
18	"id": "id",
19	"initials": "initials",
20	"name": "name",
21	"avatarUrl": "avatarUrl",
22	"permission": "permission",
23	"color": "color",
24	"permissionOptions": {
25	"none": true,
26	"collaborate": true,
27	"guest": true,
28	"editor": true,
29	"manager": true
30	},
31	"role": "role"
32	}
33	}