Notifications are presented to Users in their in-app inbox.
Bulk update Notifications
Updates the Notifications within the specified time window by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change any property of a Notification except isRead.
query Parameters
window_startstring · date-timeThe start of the time window to update
Notificationsin.window_endstring · date-timeThe end of the time window to update
Notificationsin.
Responses
The updated Notifications.
notificationsarray
Update a Notification
Updates the specified Notification by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change any property of a Notification except isRead.
path Parameters
notificationIdstring · uuid · requiredThe id of the
Notification.
Responses
The updated Notification.
notification
List Notifications of a User
By default, returns a list of the 100 most recently-created Notifications belonging to the given User, along with the Comments and Events associated with each Notification and the total count of Notifications belonging to the User.
You can increase or decrease the number of Notifications returned by specifying the limit query parameter. The default value is 100.
To paginate through the list of Notifications, use the createdBefore query parameter based on the oldest Notification returned in the previous response.
path Parameters
userIdstring · uuid · requiredThe id of the
User.
query Parameters
limitintegerThe maximum number of
Notificationsto retrieve.createdBeforestring · date-timeThe latest creation date allowed when retrieving
Notifications.
Responses
A list of Notifications, their associated Comments and Events, and the total count of Notifications.
notificationsarrayuserNotificationCountintegerThe total count of
Notificationsowned by theUser.associatedCommentsobjectThe
Commentsthat caused the retrievedNotifications.associatedEventsobject[]The
Eventsassociated with the retrievedNotifications.