Skip to navigation
API ReferenceProject Members

Add all active people on a business team to a project.

Resolves the team to its member resources, grants project access to each user who is not already a member, and leaves existing members unchanged. Access levels follow the same rules as creating or updating individual project membership (workspace role constraints, guest vs licensed user, global admin, etc.).

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"
Reference to the project receiving access.
teamIdstringRequiredformat: "uuid"

Business team identifier (BusinessTeamId); all active team members with a user account are considered.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

Optional flags for default access (e.g. editor vs collaborator) for newly added members.

addAsEditorbooleanOptional

When true, new teammates receive editor-level access (subject to workspace role rules). When false, they receive collaborator access (again subject to role rules, e.g. guests).

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
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.