Mark notification as read
Marks a notification as read and returns the updated notification.
Authorizations
Path Parameters
Notification ID
Response
OK
AppID is the ID of the custom app that created the notification, when applicable.
"550e8400-e29b-41d4-a716-446655440005"
CompanyID is the company the notification is associated with, when applicable.
"550e8400-e29b-41d4-a716-446655440003"
DefaultListIndexPkey for the notification model is used to mark whether a notification is an inbox notification
DeliveryTargets describes how the notification is delivered (in-product and/or email).
Event is the domain event that triggered the notification.
files.created, file.created, contract.signed, contract.requested, formResponse.requested, formResponse.completed, form.created, invoice.paid, invoice.requested, invoice.processing, invoice.paymentFailed, refund.requested, refund.processed, refund.failed, autoChargePayment.requested, customApp.action, internalChat.mentioned, channel.mentioned "file.created"
todo: remove fields once FE doesn't use them
Deprecated: use DeliveryTargets.InProduct.IsRead
RecipientClientID is the recipient client ID, set when the recipient is a client.
"550e8400-e29b-41d4-a716-446655440001"
RecipientCompanyID is the recipient company ID, set when the recipient is a client (their company).
"550e8400-e29b-41d4-a716-446655440003"
RecipientID is the ID of the member the notification is delivered to.
"550e8400-e29b-41d4-a716-446655440001"
RecipientInternalUserID is the recipient internal user ID, set when the recipient is an internal user.
"550e8400-e29b-41d4-a716-446655440004"
USER, CLIENT_USER, CLIENT_COMPANY ResourceID is the ID of the resource the notification refers to (e.g. the uploaded file or invoice).
"550e8400-e29b-41d4-a716-446655440002"
SenderCompanyID is the sender's company ID, set when the recipient is an internal user.
"550e8400-e29b-41d4-a716-446655440003"
SenderID is the ID of the member who triggered the notification.
"550e8400-e29b-41d4-a716-446655440000"
SenderType is the kind of member that sent the notification.
"internalUser"