Notifications
The Notifications API can be used to list the user's notifications and also to update its status once read.
Available Endpoints
GET
/integrations/notifications/{playerUnqiueId}
PUT
/integrations/notifications
GET - User Notifications
This API is used to to retrieve a specific user's list of notifications in Referd.
Request
Header
APIKey
string
Yes
Client API key
Path Parameters
Attribute
Type
Required
Description
playerUniqueId
string
Yes
Unique identifier for the user at Referd
Query Parameters
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
Response
Returns an array of notification objects described as follows:
notifications
array
count
integer
Currently displayed notifications list count
total
integer
Total number of notifications available matching the applied filters
Example:
"count": 50
"total": 200
notification
Object
notification
ObjectnotificationId
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, default lang
is returned.
Note: The language provided should be as per configured languages in your account.
Example: "en"
, "fr"
.
icon
string
Notification's icon URL.
Sample Response
Usage Example
PUT - Mark Notification(s) as Read
The API call is used to mark the user's notification(s) as read in Referd.
Request
Header
APIKey
string
Yes
Client API key
Body
notificationIds
array
Yes
An array of IDs of the notifications to be marked as read.
Example: ["12334", "14533", "55343"]
Sample Body
Usage Example
Last updated