Project Members

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

Request

This endpoint expects an object.
role
enumOptional
Role to apply
Allowed values: GuestCollaborateEditorManager

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
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
$curl -X POST /api/data/projects/projectId/members/userId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "id": "id",
14    "initials": "initials",
15    "name": "name",
16    "avatarUrl": "avatarUrl",
17    "role": "role",
18    "permission": "permission",
19    "color": "color",
20    "permissionOptions": {
21      "none": true,
22      "collaborate": true,
23      "guest": true,
24      "editor": true,
25      "manager": true
26    }
27  }
28}
Built with