Interface ReportAccountParams

interface ReportAccountParams {
    accountId: string;
    category?: null | ReportCategory;
    comment?: null | string;
    forward?: null | boolean;
    forwardToDomains?: null | readonly string[];
    ruleIds?: null | readonly string[];
    statusIds?: null | readonly string[];
}

Properties

accountId: string

ID of the account to report

category?: null | ReportCategory

category can be one of: spam, violation, other (default)

comment?: null | string

Reason for the report (default max 1000 characters)

forward?: null | boolean

If the account is remote, should the report be forwarded to the remote admin?

forwardToDomains?: null | readonly string[]
ruleIds?: null | readonly string[]

must reference rules returned in GET /api/v1/instance

statusIds?: null | readonly string[]

Array of Statuses to attach to the report, for context