From aa52a2ca174b784f0cf0b5772a79acf07dd9848a Mon Sep 17 00:00:00 2001 From: Claire Date: Fri, 17 May 2024 17:54:44 +0200 Subject: [PATCH] Add documentation for accepting and rejecting requests --- content/en/methods/notifications.md | 106 ++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) diff --git a/content/en/methods/notifications.md b/content/en/methods/notifications.md index e8a447ad..509cf7db 100644 --- a/content/en/methods/notifications.md +++ b/content/en/methods/notifications.md @@ -617,6 +617,8 @@ Invalid or missing Authorization header. } ``` +--- + ## Get a single notification request {#get-one-request} ```http @@ -705,6 +707,110 @@ Invalid or missing Authorization header. --- +## Accept a single notification request {#accept-request} + +```http +POST /api/v1/notifications/requests/:id/accept HTTP/1.1 +``` + +Accept a notification request, which merges the filtered notifications from that user back into the main notification and accepts any future notification from them. + +**Returns:** Empty\ +**OAuth:** User token + `write:notifications`\ +**Version history:**\ +4.3.0 - added + +#### Request + +##### Path parameters + +:id +: {{}} String. The ID of the Notification in the database. + +##### Headers + +Authorization +: {{}} Provide this header with `Bearer ` to gain authorized access to this API method. + +#### Response + +```http +POST https://mastodon.social/api/v1/notifications/requests/112456967201894256/accept HTTP/1.1 +Authorization: Bearer xxx +``` + +##### 200: OK + +A single notification request. + +```json +{} +``` + +##### 401: Unauthorized + +Invalid or missing Authorization header. + +```json +{ + "error": "The access token is invalid" +} +``` + +--- + +## Accept a single notification request {#dismiss-request} + +```http +POST /api/v1/notifications/requests/:id/dismiss HTTP/1.1 +``` + +Dismiss a notification request, which hides it and prevent it from contributing to the pending notification requests count. + +**Returns:** Empty\ +**OAuth:** User token + `write:notifications`\ +**Version history:**\ +4.3.0 - added + +#### Request + +##### Path parameters + +:id +: {{}} String. The ID of the Notification in the database. + +##### Headers + +Authorization +: {{}} Provide this header with `Bearer ` to gain authorized access to this API method. + +#### Response + +```http +POST https://mastodon.social/api/v1/notifications/requests/112456967201894256/accept HTTP/1.1 +Authorization: Bearer xxx +``` + +##### 200: OK + +A single notification request. + +```json +{} +``` + +##### 401: Unauthorized + +Invalid or missing Authorization header. + +```json +{ + "error": "The access token is invalid" +} +``` + +--- + ## See also {{< page-relref ref="methods/push" caption="push API methods" >}}