Alerts

Mark the alert as viewed, read, or unread

Changed on

Mark the alert as viewed, read, or unread. Marking as unviewed is not supported.

post/alerts/{id}/mark

Request

Request body application/x-www-form-urlencoded

readboolean

If specified, marks the alert as read.

unreadboolean

If specified, marks the alert as unread.

viewedboolean

If specified, marks all alerts as viewed.

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

    • warning

      deleted the path request parameter id

    • info

      api operation id post_alerts_id_mark removed and replaced with postAlertsIdMark

    • 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

      added the new path request parameter id

    • 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 postAlertsIdMark removed and replaced with post_alerts_id_mark

    • 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