v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Mark Notification Read

This API endpoint marks a notification as read.

post/v1/notifications/{id}/read

Path parameters

idstring required

The ID of the notification to mark as read.

Response

200

createdAtstring

eventstring

idstring

objectstring

recipientIdstring

recipientClientIdstring

recipientCompanyIdstring

recipientInternalUserIdstring

resourceIdstring

senderIdstring

senderTypestring

Example response

{
  "createdAt": "2024-03-07T20:01:57.952358557Z",
  "deliveryTargets": {
    "inProduct": {
      "title": "Form was submitted",
      "isRead": true
    }
  },
  "event": "formResponse.completed",
  "id": "335775a7-9115-449e-8578-45d798a1c77e:BOo5R0AIg",
  "object": "notification",
  "recipientId": "335775a7-9115-449e-8578-45d798a1c77e",
  "recipientClientId": "335775a7-9115-449e-8578-45d798a1c77e",
  "recipientCompanyId": "335775a7-9115-449e-8578-45d798a1c77e",
  "recipientInternalUserId": "335775a7-9115-449e-8578-45d798a1c77e",
  "resourceId": "16ad9666-f5f9-4816-aa0b-cec6e23115ef",
  "senderId": "dff974ea-57c7-470a-8805-ab09dc1e61ee",
  "senderType": "client"
}