Skip to content

CreateAccountActionRequest

A moderation action to take on an account.

object
kind
required

warn: a notice only. mark_statuses_sensitive and delete_statuses: actions on posts. force_sensitive: every attachment is shown as sensitive. limit: every post is followers-only and stays off the public timelines. restrict_posting: no posting. restrict_interaction: no following, favouriting, boosting, or replying. disable_login: no logging in. suspend: all of these, and the profile and posts are hidden. ban: a suspension that never ends, with the deletion of the account.

string
Allowed values: warn mark_statuses_sensitive delete_statuses force_sensitive limit restrict_posting restrict_interaction disable_login suspend ban
reason_category
string
Allowed values: spam legal violation other
public_reason

The reason shown to the account.

string
<= 5000 characters
private_note

A note for the moderators only.

string
<= 5000 characters
report_id

The report of the account that the action follows from. The action resolves an open report as actioned in the same operation; a resolved report stays as it is.

string format: uuid
notify_target

Whether a local account is told of the action; ignored for a remote one.

boolean
default: true
expires_in

The seconds the action lasts, at most ten years (315360000); omitted, it lasts until it is lifted. A ban and the actions on posts take none.

integer
>= 1 <= 315360000
status_ids

The posts of the account that delete_statuses or mark_statuses_sensitive acts on; required for them and taken by no other kind.

Array<string>
>= 1 items <= 100 items unique items
block_email

Whether a ban also blocks sign-ups with the email address of the account’s user (a reject sign-up block of kind email_hash); only a ban of a local account takes it, and a user without an email address is a 422. Omitted, nothing is blocked.

boolean

Example generated

{
"kind": "warn",
"reason_category": "other",
"public_reason": "example",
"private_note": "example",
"report_id": "01890a5d-ac96-774b-bcce-b302099a8057",
"notify_target": true,
"expires_in": 1,
"status_ids": [
"01890a5d-ac96-774b-bcce-b302099a8057"
],
"block_email": true
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site