Space Moderation

This page covers the moderation and administrative functions on the spaces module: report handling, content moderation actions, and community rules management.

Reports

handleEntityReport

Resolves a report filed against an entity in a space by applying one or more moderation actions.

const result = await sublay.spaces.handleEntityReport({
  spaceId: "spc_abc123",
  reportId: "rpt_xyz789",
  entityId: "ent_xyz789",
  actions: ["remove-entity", "ban-user"],
  reason: "Repeated spam",
});

string

required

The Sublay space ID where the report was filed.

string

required

The Sublay report ID.

string

required

The Sublay entity ID the report targets.

string[]

required

One or more actions to apply: "remove-entity", "ban-user", and/or "dismiss".

string

Optional moderator summary of the resolution.

string

Optional reason, stored for audit purposes.

string

The Sublay user ID of the moderator performing the action.

Returns — Promise<HandleReportResponse>

handleCommentReport

Resolves a report filed against a comment in a space by applying one or more moderation actions.

const result = await sublay.spaces.handleCommentReport({
  spaceId: "spc_abc123",
  reportId: "rpt_abc456",
  commentId: "cmt_abc123",
  actions: ["dismiss"],
});

string

required

The Sublay space ID where the report was filed.

string

required

The Sublay report ID.

string

required

The Sublay comment ID the report targets.

string[]

required

One or more actions to apply: "remove-comment", "ban-user", and/or "dismiss".

string

Optional moderator summary of the resolution.

string

Optional reason, stored for audit purposes.

string

The Sublay user ID of the moderator performing the action.

Returns — Promise<HandleReportResponse>

Chat message reports are handled by spaces.handleSpaceChatReport, which is documented with the other space-conversation functions in Chat → Space conversations. Reports on DM and group conversations are project-level and are resolved in the Sublay dashboard, not through this SDK.

Content Moderation

moderateSpaceEntity

Approves or removes an entity within a space.

const result = await sublay.spaces.moderateSpaceEntity({
  spaceId: "spc_abc123",
  entityId: "ent_xyz789",
  action: "remove",
  reason: "Violates community guidelines",
});

string

required

The Sublay space ID.

string

required

The Sublay entity ID to moderate.

string

required

"approve" — makes the entity visible, or "remove" — hides/removes it from the space.

string

Optional reason for the moderation action, stored for audit purposes.

Returns — Promise<ModerationResponse>

setSpaceEntityNsfw

Sets the NSFW own-flag on an entity within a space — including other users’ entities. This is a separate axis from moderateSpaceEntity: it labels the entity (nsfw), it does not approve/remove it. Requires the acting user to be an admin or moderator of the space.

const result = await sublay.spaces.setSpaceEntityNsfw({
  spaceId: "spc_abc123",
  entityId: "ent_xyz789",
  nsfw: true,
});

string

required

The Sublay space ID containing the entity.

string

required

The Sublay entity ID to flag or unflag.

boolean

required

The NSFW own-flag to set on the entity.

Returns — Promise<{ message: string; nsfw: boolean }>

moderateSpaceComment

Approves or removes a comment within a space.

const result = await sublay.spaces.moderateSpaceComment({
  spaceId: "spc_abc123",
  commentId: "cmt_abc123",
  action: "approve",
});

string

required

The Sublay space ID.

string

required

The Sublay comment ID to moderate.

string

required

"approve" or "remove".

string

Optional reason for the moderation action.

Returns — Promise<ModerationResponse>

Rules

Rules are community guidelines displayed to members. They are ordered and each consists of a title and optional description.

fetchManyRules

Fetches all rules for a space.

const result = await sublay.spaces.fetchManyRules({ spaceId: "spc_abc123" });

string

required

The Sublay space ID.

Returns — Promise<FetchManyRulesResponse>

fetchRule

Fetches a single rule by its ID.

const rule = await sublay.spaces.fetchRule({
  spaceId: "spc_abc123",
  ruleId: "rul_xyz789",
});

string

required

The Sublay space ID.

string

required

The Sublay rule ID.

Returns — Promise<Rule>

createRule

Creates a new rule for a space.

const rule = await sublay.spaces.createRule({
  spaceId: "spc_abc123",
  title: "Be respectful",
  description: "Treat all members with respect and courtesy.",
});

string

required

The Sublay space ID.

string

required

Short title for the rule.

string

Extended explanation of the rule.

Returns — Promise<Rule>

updateRule

Updates an existing rule’s title or description.

const rule = await sublay.spaces.updateRule({
  spaceId: "spc_abc123",
  ruleId: "rul_xyz789",
  title: "Be respectful and kind",
  description: "Updated description.",
});

string

required

The Sublay space ID.

string

required

The Sublay rule ID to update.

string

New title.

string

New description.

Returns — Promise<Rule>

deleteRule

Deletes a rule from a space.

const result = await sublay.spaces.deleteRule({
  spaceId: "spc_abc123",
  ruleId: "rul_xyz789",
});

string

required

The Sublay space ID.

string

required

The Sublay rule ID to delete.

Returns — Promise<DeleteRuleResponse>

reorderRules

Sets the display order of all rules for a space by providing an ordered array of rule IDs.

const rules = await sublay.spaces.reorderRules({
  spaceId: "spc_abc123",
  ruleIds: ["rul_first", "rul_second", "rul_third"],
});

string

required

The Sublay space ID.

string[]

required

Complete ordered array of all rule IDs for the space.

Returns — Promise<Rule[]> — the full list of rules in their new order.

Getting Started

Modules

Reports

handleEntityReport

handleCommentReport

Content Moderation

moderateSpaceEntity

setSpaceEntityNsfw

moderateSpaceComment

Rules

fetchManyRules

fetchRule

createRule

updateRule

deleteRule

reorderRules

​Reports

​handleEntityReport

​handleCommentReport

​Content Moderation

​moderateSpaceEntity

​setSpaceEntityNsfw

​moderateSpaceComment

​Rules

​fetchManyRules

​fetchRule

​createRule

​updateRule

​deleteRule

​reorderRules

Reports

handleEntityReport

handleCommentReport

Content Moderation

moderateSpaceEntity

setSpaceEntityNsfw

moderateSpaceComment

Rules

fetchManyRules

fetchRule

createRule

updateRule

deleteRule

reorderRules