Suspend an account: all of its content disappears from the public read surface (feeds, single fetches, threads, notifications) while the row is active. Reversible via unsuspendAccount; optionally time-boxed via `until` (evaluated at read time — a lapsed suspension readmits content with no further action). Re-suspending replaces the current suspension (new reason/expiry, new audit row). Requires the `moderator` role. Writes an `accountSuspended` audit row.
Input
application/jsoncloseAttachedReports
boolean
Optional
When true, all reports against the ACCOUNT subject still in `open` or `underReview` are marked `actioned` in the same transaction; each closed report gets a `reportClosedByCascade` audit row linked to this sanction's audit id. Reports against individual posts/replies of the account are left open — the moderator has not examined them.
did
stringdid
Required
A decentralized identifier (DID).
notifyUser
boolean
Optional
When true, persist a moderation notice addressed to the affected user (content author or account holder). Delivery is out of scope.
reason
string
Required
No description available.
maxLength: 2000 bytesminLength: 1 bytesuntil
stringdatetime
Optional
Suspension expiry. Omitted = indefinite (until explicitly unsuspended). Must be in the future.
Output
application/jsonattachedReportsClosed
integer
Required
Number of account-subject reports auto-closed in this transaction. Zero when closeAttachedReports=false or none were open.
auditEntryId
integer
Required
No description available.
Errors
Forbidden
The caller is not an active moderator. InvalidRequest
Malformed DID or `until` not in the future. AccountBanned
The account is banned — a ban is permanent and stricter than a suspension. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Suspend an account: all of its content disappears from the public read surface (feeds, single fetches, threads, notifications) while the row is active. Reversible via unsuspendAccount; optionally time-boxed via `until` (evaluated at read time — a lapsed suspension readmits content with no further action). Re-suspending replaces the current suspension (new reason/expiry, new audit row). Requires the `moderator` role. Writes an `accountSuspended` audit row.",
"errors": [
{
"description": "The caller is not an active moderator.",
"name": "Forbidden"
},
{
"description": "Malformed DID or `until` not in the future.",
"name": "InvalidRequest"
},
{
"description": "The account is banned — a ban is permanent and stricter than a suspension.",
"name": "AccountBanned"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"closeAttachedReports": {
"default": false,
"description": "When true, all reports against the ACCOUNT subject still in `open` or `underReview` are marked `actioned` in the same transaction; each closed report gets a `reportClosedByCascade` audit row linked to this sanction's audit id. Reports against individual posts/replies of the account are left open — the moderator has not examined them.",
"type": "boolean"
},
"did": {
"format": "did",
"type": "string"
},
"notifyUser": {
"default": false,
"description": "When true, persist a moderation notice addressed to the affected user (content author or account holder). Delivery is out of scope.",
"type": "boolean"
},
"reason": {
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"until": {
"description": "Suspension expiry. Omitted = indefinite (until explicitly unsuspended). Must be in the future.",
"format": "datetime",
"type": "string"
}
},
"required": [
"did",
"reason"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"attachedReportsClosed": {
"description": "Number of account-subject reports auto-closed in this transaction. Zero when closeAttachedReports=false or none were open.",
"minimum": 0,
"type": "integer"
},
"auditEntryId": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"auditEntryId",
"attachedReportsClosed"
],
"type": "object"
}
},
"type": "procedure"
}