Mark notification as read

PUT /v2/notifications/{notificationId}/status/

API version

v2

Request method

PUT

Operation ID

notifications-read-notification

---

Request

• notificationIdstring (uuid)

  required

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 PUT \
    -d '{"status":"read"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/notifications/f0f86186-0a5a-45b2-aa33-502777496347/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.notificationsReadNotification({
  "notificationId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "status": "read"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsReadNotification\NotificationsReadNotificationRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsReadNotification\NotificationsReadNotificationRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new NotificationsReadNotificationRequest(
  notificationId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->notification()->notificationsReadNotification($request);

var_dump($response->getBody();