Update a notification's read status

PUT/v2/notifications/{notificationId}/status

API-Version

v2

Request-Methode

PUT

Operation-ID

notifications-update-notification-status

Request

• notificationIdstring (uuid)required

Responses

Format

application/json

Beschreibung

OK

• statusstring (einer von: read, unread)required

Content-Type: application/json

{
  "status": "read"
}

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

Nutzungsbeispiele

$ 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

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.notificationsUpdateNotificationStatus({
  "notificationId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "status": "read"
  }
});

assertStatus(response, 200);
  

use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsUpdateNotificationStatus\NotificationsUpdateNotificationStatusRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Notification\NotificationsUpdateNotificationStatus\NotificationsUpdateNotificationStatusRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

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

var_dump($response->getBody();