diff options
| author | rinpatch <rinpatch@sdf.org> | 2019-09-04 11:33:08 +0300 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2019-09-04 12:38:27 +0300 |
| commit | c2b6c1b089a813cf8c7cbd54c0f80bee4985522c (patch) | |
| tree | 0d9ee1d4bd3a6279aa3b04eb51d93d07094ebd0f /docs/api | |
| parent | 46ffd8b3b6359ec796733a8fff5bdb7d03a728d5 (diff) | |
| download | pleroma-c2b6c1b089a813cf8c7cbd54c0f80bee4985522c.tar.gz | |
Extend `/api/pleroma/notifications/read` to mark multiple notifications
as read and make it respond with Mastoapi entities
Diffstat (limited to 'docs/api')
| -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..e76a35b3b 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/pleroma/v1/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. In case of `max_id`, only the first 80 notifications will be returned. ## `/api/v1/pleroma/accounts/:id/subscribe` ### Subscribe to receive notifications for all statuses posted by a user |