Skip to main content
POST
Mark notification as unread

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Notification ID

Response

OK

additionalFields
object
appId
string<uuid>

AppID is the ID of the custom app that created the notification, when applicable.

Example:

"550e8400-e29b-41d4-a716-446655440005"

assetS3Key
string
channelId
string
companyId
string<uuid>

CompanyID is the company the notification is associated with, when applicable.

Example:

"550e8400-e29b-41d4-a716-446655440003"

count
integer
createdAt
string
creatorId
string
data
string
defaultListIndexPkey
string

DefaultListIndexPkey for the notification model is used to mark whether a notification is an inbox notification

deliveryTargets
object

DeliveryTargets describes how the notification is delivered (in-product and/or email).

event
enum<string>

Event is the domain event that triggered the notification.

Available options:
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
Example:

"file.created"

fields
object

todo: remove fields once FE doesn't use them

id
string
identityId
string
isGroup
boolean
isRead
boolean

Deprecated: use DeliveryTargets.InProduct.IsRead

object
string
previousAttributes
object
recipientClientId
string<uuid>

RecipientClientID is the recipient client ID, set when the recipient is a client.

Example:

"550e8400-e29b-41d4-a716-446655440001"

recipientCompanyId
string<uuid>

RecipientCompanyID is the recipient company ID, set when the recipient is a client (their company).

Example:

"550e8400-e29b-41d4-a716-446655440003"

recipientId
string<uuid>

RecipientID is the ID of the member the notification is delivered to.

Example:

"550e8400-e29b-41d4-a716-446655440001"

recipientInternalUserId
string<uuid>

RecipientInternalUserID is the recipient internal user ID, set when the recipient is an internal user.

Example:

"550e8400-e29b-41d4-a716-446655440004"

recipientType
enum<string>
Available options:
USER,
CLIENT_USER,
CLIENT_COMPANY
ref
string
reminders
object
resourceId
string

ResourceID is the ID of the resource the notification refers to (e.g. the uploaded file or invoice).

Example:

"550e8400-e29b-41d4-a716-446655440002"

senderCompanyId
string<uuid>

SenderCompanyID is the sender's company ID, set when the recipient is an internal user.

Example:

"550e8400-e29b-41d4-a716-446655440003"

senderId
string<uuid>

SenderID is the ID of the member who triggered the notification.

Example:

"550e8400-e29b-41d4-a716-446655440000"

senderType
enum<string>

SenderType is the kind of member that sent the notification.

Example:

"internalUser"

updatedAt
string