Notifications 👑
The Notifications API can be used to list the customer's notifications and also to update its status once read.
Available Endpoints
Type | Description | Endpoint |
GET | /integrations/notifications/{playerUnqiueId} | |
PUT | /integrations/notifications |
This endpoint is only available for our GURU clients only. 👑
GET - Customer Notifications
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.
Request
Header
Attribute | Type | Required | Description |
| string | Yes | Client API key |
Path Parameters
Attribute | Type | Required | Description |
| string | Yes | Unique identifier for the customer at Gameball |
Query Parameters
Attribute | Type | Required | Description |
| boolean | No | Read status filter. This could be used in case you need to filter notifications based on their read status. |
| 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: |
| integer | No | Result page number. Starts from 1. Default is 1 |
| integer | No | Result page size. Default is 50 notifications and Max is 200 |
Response
Attribute | Type | Description |
| array | List of returned notification objects. |
| integer | returned currently displayed notifications list count |
| integer | total number of notifications available matching the applied filters Example:
|
notification
Object
notification
ObjectAttribute | Type | Description |
| string | Unique Identifier for a notification . |
| string | Notification Title |
| string | Notification Body |
| boolean | Indicates whether the notification is read or not. |
| string | Notification's creation date, as an ISO8601 timestamp. Example: |
| string | The language in which the notification is displayed.
In case the Note: The language provided should be as per configured languages in your account. Example: |
| string | Notification's icon URL. |
Sample Response
Usage Example
PUT - Mark Notification(s) as Read
The API call is used to mark the customer's notification(s) as read in Gameball.
Request
Header
Attribute | Type | Required | Description |
| string | Yes | Client API key |
Body
Attribute | Type | Required | Description |
| array | Yes | An array of IDs of the notifications to be marked as read. Example: |