commit: 699fc9569fa06278baaec6804348375cb9891185
parent: 12bb7fc0dc94068d8337f10fc337ab23c8c7e77e
Author: lain <lain@soykaf.club>
Date: Tue, 28 Apr 2020 15:40:18 +0000
Merge branch 'docs/notification_destroy_multiple' into 'develop'
Document DELETE /api/v1/notifications/destroy_multiple
Closes #1711
See merge request pleroma/pleroma!2435
Diffstat:
1 file changed, 12 insertions(+), 0 deletions(-)
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md
@@ -120,6 +120,18 @@ Accepts additional parameters:
- `exclude_visibilities`: will exclude the notifications for activities with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`). Usage example: `GET /api/v1/notifications?exclude_visibilities[]=direct&exclude_visibilities[]=private`.
- `include_types`: will include the notifications for activities with the given types. The parameter accepts an array of types (`mention`, `follow`, `reblog`, `favourite`, `move`, `pleroma:emoji_reaction`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
+## DELETE `/api/v1/notifications/destroy_multiple`
+
+An endpoint to delete multiple statuses by IDs.
+
+Required parameters:
+
+- `ids`: array of activity ids
+
+Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
+
+Returns on success: 200 OK `{}`
+
## POST `/api/v1/statuses`
Additional parameters can be added to the JSON body/Form data: