Mark all notifications as read (deprecated)

PUT /v2/notifications/status/

warning

This operation is deprecated and should not be used anymore. Please refer to this operation's description for alternatives.

API version

v2

Request method

PUT

Operation ID

notifications-read-all-notifications-deprecated

---

Deprecated route. Please use /v2/notifications/actions/read-all instead.

Request

Responses

Format

application/json

Description

OK

Schema documentation

• status"read"

  required

Example

{
  "status": "read"
}

JSON Schema

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

Usage examples

cURL

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

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.notificationsReadAllNotificationsDeprecated({
  "data": {}
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsReadAllNotificationsDeprecated\NotificationsReadAllNotificationsDeprecatedRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsReadAllNotificationsDeprecated\NotificationsReadAllNotificationsDeprecatedRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new NotificationsReadAllNotificationsDeprecatedRequest(
  body: $body
));
$response = $client->notification()->notificationsReadAllNotificationsDeprecated($request);

var_dump($response->getBody();