documentation/content/en/api/rest/reports.md

25 lines
609 B
Markdown
Raw Normal View History

2018-09-26 00:19:54 +02:00
---
title: Reports
2018-09-26 00:19:54 +02:00
menu:
docs:
parent: rest-api
2018-09-26 00:19:54 +02:00
weight: 10
---
2018-10-05 01:29:57 +02:00
## POST /api/v1/reports
2018-10-05 01:37:50 +02:00
Report an account.
2018-10-05 01:29:57 +02:00
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:reports" version="1.1.0" >}}
2018-10-05 01:29:57 +02:00
### Parameters
2018-10-06 00:42:15 +02:00
|Name|Description|Required|
|----|-----------|:------:|
| `account_id` | The ID of the account to report | Required |
| `status_ids` | The IDs of statuses to report as array | Optional |
| `comment` | Reason for the report (up to 1,000 characters) | Optional |
| `forward` | Whether to forward to the remote admin (in case of a remote account) | Optional |