Document DELETE /api/v1/notifications/destroy_multiple
authorMark Felder <feld@FreeBSD.org>
Tue, 28 Apr 2020 15:13:58 +0000 (10:13 -0500)
committerMark Felder <feld@FreeBSD.org>
Tue, 28 Apr 2020 15:13:58 +0000 (10:13 -0500)
docs/API/differences_in_mastoapi_responses.md

index 92199551087f1503eb6ecf88ec015138231f32ff..289f859306fe229b96b0a5fb8989577ca78d49eb 100644 (file)
@@ -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: