Alerts

Mark all alerts as read or viewed

Changed on

Mark all alerts as read or viewed. Must specify "read" or "viewed" parameters.

post/alerts/mark-all

Request

Request body application/x-www-form-urlencoded

readboolean

If specified, marks all alerts as read.

viewedboolean

If specified, marks all alerts as viewed. This will remove the alert counter but keep unactioned alerts highlighted.

Response

OK

successboolean

Changes

    • breaking

      removed the media type application/json from the request body

    • breaking

      the response's property type changed from string to boolean for status

    • info

      api operation id post_alerts_mark_all removed and replaced with postAlertsMarkAll

    • info

      the endpoint scheme security XF-Api-Key was added to the API

    • info

      the endpoint scheme security XF-OAuth2 was added to the API

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

    • breaking

      the response's property type changed from boolean to string for status

    • warning

      the optional response header XF-Latest-Api-Version removed for the status 200

    • warning

      the optional response header XF-Request-User removed for the status 200

    • warning

      the optional response header XF-Request-User-Extras removed for the status 200

    • warning

      the optional response header XF-Used-Api-Version removed for the status 200

    • info

      api operation id postAlertsMarkAll removed and replaced with post_alerts_mark_all

    • info

      the endpoint scheme security XF-Api-Key was removed from the API

    • info

      the endpoint scheme security XF-OAuth2 was removed from the API

    • info

      added the media type application/json to the request body