API ReferenceEntityUserNotifications

Update

Update the status of a notification.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID
userIdstringRequired
User ID or User ForeignID
notificationIdstringRequired

Request

This endpoint expects an object.
statusenumOptional
Allowed values:

Response

This endpoint returns an object.
idstring
typeenum
statusenum
Allowed values:
createdAtdatetime
invoiceIdstring
The invoice ID that this notification is related to. This field is only present for notifications related to invoices.

Errors

400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
409
Conflict
500
Internal Server Error
501
Unimplemented