Notifications 👑
The Notifications API can be used to list the customer's notifications and also to update its status once read.
Last updated
The Notifications API can be used to list the customer's notifications and also to update its status once read.
Last updated
This endpoint is only available for our GURU clients only. 👑
This API is used to to retrieve a specific customer's list of notifications in Gameball.
mobile
or email
should replace the playerUniqueId
in case (only if) your account supports channel merging.
notification
ObjectThe API call is used to mark the customer's notification(s) as read in Gameball.
Type
Description
Endpoint
GET
/integrations/notifications/{playerUnqiueId}
PUT
/integrations/notifications
Attribute
Type
Required
Description
APIKey
string
Yes
Client API key
Attribute
Type
Required
Description
playerUniqueId
string
Yes
Unique identifier for the customer at Gameball
Attribute
Type
Required
Description
isRead
boolean
No
Read status filter. This could be used in case you need to filter notifications based on their read status.
lang
string
No
Language filter. This could be used to specify the language needed to display the notification in. Note: The language provided should be as per configured languages in your account.
Example: "en"
, "fr"
.
page
integer
No
Result page number. Starts from 1. Default is 1
limit
integer
No
Result page size. Default is 50 notifications and Max is 200
Attribute
Type
Description
notifications
array
List of returned notification objects.
count
integer
returned currently displayed notifications list count
total
integer
total number of notifications available matching the applied filters
Example:
"count": 50
"total": 200
Attribute
Type
Description
notificationId
string
Unique Identifier for a notification .
title
string
Notification Title
body
string
Notification Body
isRead
boolean
Indicates whether the notification is read or not.
createdAt
string
Notification's creation date, as an ISO8601 timestamp.
Example: "2019-09-21T16:53:28.190Z"
lang
string
The language in which the notification is displayed.
In case the lang
is not provided in the request, defaultlang
is returned.
Note: The language provided should be as per configured languages in your account.
Example: "en"
, "fr"
.
icon
string
Notification's icon URL.
Attribute
Type
Required
Description
APIKey
string
Yes
Client API key
Attribute
Type
Required
Description
notificationIds
array
Yes
An array of IDs of the notifications to be marked as read.
Example: ["12334", "14533", "55343"]