Mark all notifications as read

POST /v2/notifications/actions/read-all/

API version

v2

Request method

POST

Operation ID

notifications-read-all-notifications

---

Mark all notifications for the authenticated user as read.

Request

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• status"read"

  required

Beispiel

{
  "status": "read"
}

JSON Schema

{
  "properties": {
    "status": {
      "enum": [
        "read"
      ],
      "type": "string"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/notifications/actions/read-all

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.notification.notificationsReadAllNotifications({
  "data": {}
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsReadAllNotifications\NotificationsReadAllNotificationsRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsReadAllNotifications\NotificationsReadAllNotificationsRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// NotificationsReadAllNotificationsRequestBody to learn how to construct a valid instance
$body = new NotificationsReadAllNotificationsRequestBody(/* TODO: ... */);

$request = (new NotificationsReadAllNotificationsRequest(
  body: $body
));
$response = $client->notification()->notificationsReadAllNotifications($request);

var_dump($response->getBody();