Remove member

Remove (ban) a member from a space

Overview

useRemoveMember returns a callable function for removing a member from a space by setting their status to "banned". Requires the caller to be a moderator or admin. Only admins can remove other admins.

Usage Example

import { useRemoveMember } from "@sublay/react-js";

function MemberActions({ spaceId, memberId }: { spaceId: string; memberId: string }) {
  const removeMember = useRemoveMember();

  return (
    <button onClick={() => removeMember({ spaceId, memberId })}>
      Ban Member
    </button>
  );
}

Parameters

spaceId · string · required

UUID of the space.

memberId · string · required

UUID of the membership record to ban.

Returns

message · string

Confirmation message.

See also: useUnbanMember to reverse a ban.