Memberships · workspaceMembersUpdateRole

Change a workspace member role

Changes a direct workspace membership. Requires a direct platform user session and current administration of the workspace or its organization. Owners and your own membership are protected.

PATCH/v1/workspaces/{workspaceId}/members/{userId}

betaplatformUserworkspace

When to use

Change a direct workspace member role.

For agents

Requires the signed-in administrator’s direct platform access token.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const client = new PermuteClient({ accessToken: async () => process.env.PERMUTE_ACCESS_TOKEN! });
const result = await client.workspaceMembers.updateRole('wksp_finance123', 'user_example', {
  "role": "viewer"
});

Request body

json

{
  "role": "viewer"
}

Response

json

{
  "data": {
    "userId": "user_example",
    "role": "viewer"
  }
}