diff options
| author | Maksim Pechnikov <parallel588@gmail.com> | 2019-09-06 14:01:07 +0300 |
|---|---|---|
| committer | Maksim Pechnikov <parallel588@gmail.com> | 2019-09-06 14:01:07 +0300 |
| commit | eb74c3d5c7a4bebbee43e123661d87e7605a32ba (patch) | |
| tree | 5a034ddf84ce2fb0bb72501b146df967299c3685 /docs/api/pleroma_api.md | |
| parent | 6ef0103ca0b194971a2e6f61685316536b742a11 (diff) | |
| parent | 896ffabe37406e85c2a3c2f30d2e882c68b5831e (diff) | |
| download | pleroma-eb74c3d5c7a4bebbee43e123661d87e7605a32ba.tar.gz | |
Merge branch 'develop' into issue/1218
Diffstat (limited to 'docs/api/pleroma_api.md')
| -rw-r--r-- | docs/api/pleroma_api.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md index b134b31a8..7d343e97a 100644 --- a/docs/api/pleroma_api.md +++ b/docs/api/pleroma_api.md @@ -126,13 +126,14 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi ## `/api/pleroma/admin/`… See [Admin-API](Admin-API.md) -## `/api/pleroma/notifications/read` -### Mark a single notification as read +## `/api/v1/pleroma/notifications/read` +### Mark notifications as read * Method `POST` * Authentication: required -* Params: - * `id`: notification's id -* Response: JSON. Returns `{"status": "success"}` if the reading was successful, otherwise returns `{"error": "error_msg"}` +* Params (mutually exclusive): + * `id`: a single notification id to read + * `max_id`: read all notifications up to this id +* Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned. ## `/api/v1/pleroma/accounts/:id/subscribe` ### Subscribe to receive notifications for all statuses posted by a user |