Space Moderation

The space moderation functions let admins and moderators resolve reports, moderate entities, comments, and chat messages, and manage community rules within a space.

handleEntityReport

Resolves a reported entity by applying one or more actions.

const result = await sublay.spaces.handleEntityReport({
  spaceId: "spc_abc123",
  reportId: "rep_111",
  entityId: "ent_222",
  actions: ["remove-entity", "ban-user"],
  reason: "Spam",
  summary: "Removed and banned for spam",
});

string

required

The Sublay space ID.

string

required

The ID of the report to resolve.

string

required

The ID of the reported entity.

string[]

required

One or more actions to apply: "remove-entity", "ban-user", and/or "dismiss". "ban-user" bans the author of the reported content and requires reason.

string

The resolution note stored on the report. Required, whatever the actions.

string

Reason for the ban, kept in the space’s ban log. Required when actions includes ban-user.

Returns — Promise<{ message: string; code: string }>

handleCommentReport

Resolves a reported comment by applying one or more actions.

const result = await sublay.spaces.handleCommentReport({
  spaceId: "spc_abc123",
  reportId: "rep_111",
  commentId: "cmt_222",
  actions: ["dismiss"],
  summary: "No violation found",
});

string

required

The Sublay space ID.

string

required

The ID of the report to resolve.

string

required

The ID of the reported comment.

string[]

required

One or more actions to apply: "remove-comment", "ban-user", and/or "dismiss". "ban-user" bans the author of the reported content and requires reason.

string

The resolution note stored on the report. Required, whatever the actions.

string

Reason for the ban, kept in the space’s ban log. Required when actions includes ban-user.

Returns — Promise<{ message: string; code: string }>

handleSpaceChatReport

Resolves a reported space chat message by applying one or more actions.

const result = await sublay.spaces.handleSpaceChatReport({
  spaceId: "spc_abc123",
  reportId: "rep_111",
  actions: ["remove-message"],
  messageId: "msg_222",
});

string

required

The Sublay space ID.

string

required

The ID of the report to resolve.

string[]

required

One or more actions to apply: "remove-message", "ban-user", and/or "dismiss". "ban-user" bans the author of the reported content and requires reason.

string

A summary of the resolution.

string

Reason for the ban, kept in the space’s ban log, and the removal reason for remove-message. Required when actions includes ban-user.

string

The message to remove. Required when actions includes "remove-message".

Returns — Promise<{ message: string; code: string }>

moderateSpaceEntity

Approves or removes an entity in a space.

const result = await sublay.spaces.moderateSpaceEntity({
  spaceId: "spc_abc123",
  entityId: "ent_222",
  action: "remove",
  reason: "Off-topic",
});

string

required

The Sublay space ID.

string

required

The ID of the entity to moderate.

string

required

The action to take: "approve" or "remove".

string

The reason for the moderation action.

Returns — Promise<{ message: string; moderationStatus: "approved" | "removed" }>

setSpaceEntityNsfw

Sets the NSFW own-flag on an entity within a space — including other users’ entities. Separate 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_222",
  nsfw: true,
});

string

required

The Sublay space ID containing the entity.

string

required

The ID of the entity 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 in a space.

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

string

required

The Sublay space ID.

string

required

The ID of the comment to moderate.

string

required

The action to take: "approve" or "remove".

string

The reason for the moderation action.

Returns — Promise<{ message: string; moderationStatus: "approved" | "removed" }>

moderateSpaceChatMessage

Applies a moderation status to a space chat message.

const result = await sublay.spaces.moderateSpaceChatMessage({
  spaceId: "spc_abc123",
  messageId: "msg_222",
  moderationStatus: "removed",
  moderationReason: "Spam",
});

string

required

The Sublay space ID.

string

required

The ID of the chat message to moderate.

string

required

The moderation status to apply: "removed".

string

The reason for the moderation action.

Returns — Promise<{ message: string; moderationStatus: string }>

fetchManyRules

Fetches all rules for a space.

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

string

required

The Sublay space ID.

Returns — Promise<FetchManyRulesResponse>

fetchRule

Fetches a single rule by ID.

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

string

required

The Sublay space ID.

string

required

The ID of the rule to fetch.

Returns — Promise<Rule>

createRule

Creates a rule in a space.

const rule = await sublay.spaces.createRule({
  spaceId: "spc_abc123",
  title: "Be respectful",
  description: "No harassment or hate speech.",
});

string

required

The Sublay space ID.

string

required

The rule title.

string

The rule description.

Returns — Promise<Rule>

updateRule

Updates a rule’s title and/or description.

const rule = await sublay.spaces.updateRule({
  spaceId: "spc_abc123",
  ruleId: "rul_222",
  title: "Be kind",
});

string

required

The Sublay space ID.

string

required

The ID of the rule to update.

string

The new rule title.

string

The new rule description.

Returns — Promise<Rule>

deleteRule

Deletes a rule.

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

string

required

The Sublay space ID.

string

required

The ID of the rule to delete.

Returns — Promise<DeleteRuleResponse>

reorderRules

Reorders a space’s rules.

const rules = await sublay.spaces.reorderRules({
  spaceId: "spc_abc123",
  ruleIds: ["rul_333", "rul_111", "rul_222"],
});

string

required

The Sublay space ID.

string[]

required

The rule IDs in the new order.

Returns — Promise<Rule[]>

Getting Started

Modules

handleEntityReport

handleCommentReport

handleSpaceChatReport

moderateSpaceEntity

setSpaceEntityNsfw

moderateSpaceComment

moderateSpaceChatMessage

fetchManyRules

fetchRule

createRule

updateRule

deleteRule

reorderRules

​handleEntityReport

​handleCommentReport

​handleSpaceChatReport

​moderateSpaceEntity

​setSpaceEntityNsfw

​moderateSpaceComment

​moderateSpaceChatMessage

​fetchManyRules

​fetchRule

​createRule

​updateRule

​deleteRule

​reorderRules

handleEntityReport

handleCommentReport

handleSpaceChatReport

moderateSpaceEntity

setSpaceEntityNsfw

moderateSpaceComment

moderateSpaceChatMessage

fetchManyRules

fetchRule

createRule

updateRule

deleteRule

reorderRules