Memberships · workspaceMembersRemove

Remove a workspace member

Removes a direct workspace membership. Access inherited from the organization can still apply. Requires a direct platform user session and current administration of the workspace or its organization.

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

betaplatformUserworkspace

When to use

Remove a direct workspace membership.

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.remove('wksp_finance123', 'user_example');

Response

json

{
  "data": {
    "removed": true
  }
}