Notification System Service
Create Push Notification Settings for User
PATCH
/v1/users/{uuid}/push_notifications_settings/{id}/enable
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
200 OK
Remove Push Notification Settings for User
PATCH
/v1/users/{uuid}/push_notifications_settings/{id}/disable
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
200 OK
List User Notification Settings
GET
/v1/users/{uuid}/push_notifications_settings
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
"userNotifications": [
{
"pushNotificationTypeId": "1",
"userUuid": "83661851-2316-494a-a37c-5e8c910b1964",
"title": "You have been invited to game!",
"description": "You have been invited to a pickleball game!"
}
]
}
Mark Notification as Unread
PATCH
/v1/users/{uuid}/push_notifications/{id}/unread
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Id parameter is notification ID that is available in notification meta data.
Request
Empty
Mark Notification as Read
PATCH
/v1/users/{uuid}/push_notifications/{id}/read
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Id parameter is notification ID that is available in notification meta data.
Request
Empty
List Unread User Notifications
GET
/v1//users/{uuid}/push_notifications
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
This is POST due to security handlings.
Request
Empty
Response
{
"notifications": [
{
"id": "1",
"push_notification_type_id": "1",
"user_uuid": "9F56537A-3C8C-463B-B8E6-175A891065E2",
"created_at": "2023-11-22T23:58:50.010Z",
"read_at": null,
"event_name": "Event TEST",
"content": "CONTENT",
"notification_for": "keno",
"notification_for_uuid": "x"
}
],
"total_notifications": "1"
}