> ## Documentation Index
> Fetch the complete documentation index at: https://replyke-feat-push-rich-payload-fields.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Space Moderation
> Resolve reports, moderate content, and manage rules and digest delivery
The space moderation functions let admins and moderators resolve reports, moderate entities, comments, and chat messages, manage community rules, and configure digest delivery within a space.
***
### handleEntityReport
Resolves a reported entity by applying one or more actions.
```typescript theme={null}
const result = await sublay.spaces.handleEntityReport({
spaceId: "spc_abc123",
reportId: "rep_111",
entityId: "ent_222",
actions: ["remove-entity", "ban-user"],
userId: "usr_333",
});
```
The Sublay space ID.
The ID of the report to resolve.
The ID of the reported entity.
One or more actions to apply: `"remove-entity"`, `"ban-user"`, and/or `"dismiss"`.
A summary of the resolution.
The reason for the resolution.
The user to ban. Required when `actions` includes `"ban-user"`.
`userId` here is the ban **target** — the user being banned — not the actor performing the moderation.
**Returns** — `Promise<{ message: string; code: string }>`
***
### handleCommentReport
Resolves a reported comment by applying one or more actions.
```typescript theme={null}
const result = await sublay.spaces.handleCommentReport({
spaceId: "spc_abc123",
reportId: "rep_111",
commentId: "cmt_222",
actions: ["dismiss"],
});
```
The Sublay space ID.
The ID of the report to resolve.
The ID of the reported comment.
One or more actions to apply: `"remove-comment"`, `"ban-user"`, and/or `"dismiss"`.
A summary of the resolution.
The reason for the resolution.
The user to ban. Required when `actions` includes `"ban-user"`.
`userId` here is the ban **target** — the user being banned — not the actor performing the moderation.
**Returns** — `Promise<{ message: string; code: string }>`
***
### handleSpaceChatReport
Resolves a reported space chat message by applying one or more actions.
```typescript theme={null}
const result = await sublay.spaces.handleSpaceChatReport({
spaceId: "spc_abc123",
reportId: "rep_111",
actions: ["remove-message"],
messageId: "msg_222",
});
```
The Sublay space ID.
The ID of the report to resolve.
One or more actions to apply: `"remove-message"`, `"ban-user"`, and/or `"dismiss"`.
A summary of the resolution.
The reason for the resolution.
The user to ban. Required when `actions` includes `"ban-user"`.
The message to remove. Required when `actions` includes `"remove-message"`.
`userId` here is the ban **target** — the user being banned — not the actor performing the moderation.
**Returns** — `Promise<{ message: string; code: string }>`
***
### moderateSpaceEntity
Approves or removes an entity in a space.
```typescript theme={null}
const result = await sublay.spaces.moderateSpaceEntity({
spaceId: "spc_abc123",
entityId: "ent_222",
action: "remove",
reason: "Off-topic",
});
```
The Sublay space ID.
The ID of the entity to moderate.
The action to take: `"approve"` or `"remove"`.
The reason for the moderation action.
**Returns** — `Promise<{ message: string; moderationStatus: "approved" | "removed" }>`
***
### moderateSpaceComment
Approves or removes a comment in a space.
```typescript theme={null}
const result = await sublay.spaces.moderateSpaceComment({
spaceId: "spc_abc123",
commentId: "cmt_222",
action: "approve",
});
```
The Sublay space ID.
The ID of the comment to moderate.
The action to take: `"approve"` or `"remove"`.
The reason for the moderation action.
**Returns** — `Promise<{ message: string; moderationStatus: "approved" | "removed" }>`
***
### moderateSpaceChatMessage
Applies a moderation status to a space chat message.
```typescript theme={null}
const result = await sublay.spaces.moderateSpaceChatMessage({
spaceId: "spc_abc123",
messageId: "msg_222",
moderationStatus: "removed",
moderationReason: "Spam",
});
```
The Sublay space ID.
The ID of the chat message to moderate.
The moderation status to apply: `"removed"`.
The reason for the moderation action.
**Returns** — `Promise<{ message: string; moderationStatus: string }>`
***
### fetchManyRules
Fetches all rules for a space.
```typescript theme={null}
const rules = await sublay.spaces.fetchManyRules({ spaceId: "spc_abc123" });
```
The Sublay space ID.
**Returns** — `Promise`
***
### fetchRule
Fetches a single rule by ID.
```typescript theme={null}
const rule = await sublay.spaces.fetchRule({
spaceId: "spc_abc123",
ruleId: "rul_222",
});
```
The Sublay space ID.
The ID of the rule to fetch.
**Returns** — `Promise`
***
### createRule
Creates a rule in a space.
```typescript theme={null}
const rule = await sublay.spaces.createRule({
spaceId: "spc_abc123",
title: "Be respectful",
description: "No harassment or hate speech.",
});
```
The Sublay space ID.
The rule title.
The rule description.
**Returns** — `Promise`
***
### updateRule
Updates a rule's title and/or description.
```typescript theme={null}
const rule = await sublay.spaces.updateRule({
spaceId: "spc_abc123",
ruleId: "rul_222",
title: "Be kind",
});
```
The Sublay space ID.
The ID of the rule to update.
The new rule title.
The new rule description.
**Returns** — `Promise`
***
### deleteRule
Deletes a rule.
```typescript theme={null}
const result = await sublay.spaces.deleteRule({
spaceId: "spc_abc123",
ruleId: "rul_222",
});
```
The Sublay space ID.
The ID of the rule to delete.
**Returns** — `Promise`
***
### reorderRules
Reorders a space's rules.
```typescript theme={null}
const rules = await sublay.spaces.reorderRules({
spaceId: "spc_abc123",
ruleIds: ["rul_333", "rul_111", "rul_222"],
});
```
The Sublay space ID.
The rule IDs in the new order.
**Returns** — `Promise`
***
### fetchDigestConfig
Fetches the digest configuration for a space.
```typescript theme={null}
const config = await sublay.spaces.fetchDigestConfig({
spaceId: "spc_abc123",
});
```
The Sublay space ID.
**Returns** — `Promise`
***
### updateDigestConfig
Updates the digest configuration.
```typescript theme={null}
const config = await sublay.spaces.updateDigestConfig({
spaceId: "spc_abc123",
digestEnabled: true,
digestWebhookUrl: "https://example.com/digest",
digestScheduleHour: 9,
digestTimezone: "America/New_York",
});
```
The Sublay space ID.
Whether digest delivery is enabled.
The webhook URL to deliver the digest to.
The secret used to sign digest webhook deliveries.
The hour of day at which the digest is delivered.
The timezone used to interpret the schedule hour.
**Returns** — `Promise`