aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-04-28 15:40:18 +0000
committerlain <lain@soykaf.club>2020-04-28 15:40:18 +0000
commit699fc9569fa06278baaec6804348375cb9891185 (patch)
treec9ef0459e7dc3985a3d4e8aecf42ae26151ad22d
parent12bb7fc0dc94068d8337f10fc337ab23c8c7e77e (diff)
parent4b3298133b78ad67b61b07e2f267e5587ceef7bf (diff)
downloadpleroma-699fc9569fa06278baaec6804348375cb9891185.tar.gz
Merge branch 'docs/notification_destroy_multiple' into 'develop'
Document DELETE /api/v1/notifications/destroy_multiple Closes #1711 See merge request pleroma/pleroma!2435
-rw-r--r--docs/API/differences_in_mastoapi_responses.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md
index 921995510..289f85930 100644
--- 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: