Workspace Members

Update workspace members

Changed on

Update roles of existing workspace members. The request requires the workspace identifier in the path and member update details in the request body.

Notes: Workspace collaboration APIs are available on cloud-hosted Business plans and above, and on licensed self-hosted deployments (Business plan and above).

patch/api/v3/meta/workspaces/{workspaceId}/members

Request

Path parameters

workspaceIdstring required

Unique identifier for the workspace where the members will be updated.

Request body

user_idstring required

Unique identifier for the user

workspace_role'workspace-level-owner' | 'workspace-level-creator' | 'workspace-level-editor' | 'workspace-level-viewer' | 'workspace-level-commenter' | 'workspace-level-no-access' required

Workspace roles for the user. These are the values accepted when granting a role.

Response

Workspace members were updated successfully.

emailstring email required

Email address of the user

user_idstring required

Unique identifier for the user

created_atstring date-time required

Timestamp when the user was added to the workspace

updated_atstring date-time required

Timestamp when the user was last updated in the workspace

workspace_role'workspace-level-owner' | 'workspace-level-creator' | 'workspace-level-editor' | 'workspace-level-viewer' | 'workspace-level-commenter' | 'workspace-level-no-access' | 'workspace-level-inherit' required

Workspace role as reported on a member read. A superset of WorkspaceRoles: workspace-level-inherit means the role is inherited from the organization rather than set on the workspace. It cannot be assigned — it is never valid in a request body.

Changes

    • warning

      added the new workspace-level-inherit enum value to the / response property for the response status