diff options
| author | Maxim Filippov <colixer@gmail.com> | 2019-09-04 19:40:07 +0300 |
|---|---|---|
| committer | Maxim Filippov <colixer@gmail.com> | 2019-09-04 19:40:07 +0300 |
| commit | 3542ca6702707ace070761c57350c10cd8c2a745 (patch) | |
| tree | 9ad8d143eddf0ae9f4e8ebcb453f466fa1b8b9ed /docs/api/pleroma_api.md | |
| parent | 6c2fd1b78bbbb4486a5dddeffa053199ba8cc015 (diff) | |
| parent | e72531bfacb2399ad0783a26b1c23f0bba24a107 (diff) | |
| download | pleroma-3542ca6702707ace070761c57350c10cd8c2a745.tar.gz pleroma-3542ca6702707ace070761c57350c10cd8c2a745.zip | |
Merge branch 'develop' into feature/moderation-log-filters
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 |