Delete rule

Delete a community rule from a space

Overview

useDeleteRule returns a callable function for permanently deleting a rule. Only space admins can delete rules.

Usage Example

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

function DeleteRuleButton({ spaceId, ruleId }: { spaceId: string; ruleId: string }) {
  const deleteRule = useDeleteRule();

  return (
    <button onClick={() => deleteRule({ spaceId, ruleId })}>
      Delete Rule
    </button>
  );
}

Parameters

spaceId · string · required

UUID of the space.

ruleId · string · required

UUID of the rule to delete.

Returns

message · string

Confirmation message.

deletedRule · object

The id and title of the deleted rule.