Customer Notifications
Retrieve and manage customer notifications with these APIs. Use them to display notification lists and mark notifications as read, helping keep customers informed about their rewards and activity.
Available APIs
GET - Customer Notifications
This API is used to to retrieve a specific customer's list of notifications in Gameball.
Security: Requires apikey and secretkey headers.
Request
Path Parameters
customerId string
Required
Unique identifier for the customer that you can reference across the customer’s whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.
Response
application/json
notifications array
This array contains the list of notifications sent to the customer. Each notification represents an event or update that happened, based on pre-configured settings from the Gameball dashboard. These notifications are typically used to inform the customer about specific actions such as cashback rewards, point adjustments, tier changes, or campaign achievement. Each object in the array provides details about the notification, such as its content, creation date, and read status.
Example : When a customer receives a cashback reward, the system sends a notification with details about the reward (if you have enabled the cashback reward notification on your dashboard). For example, the title could be "Cashback Reward!" and the body might include "You’ve received a cashback reward for your recent purchase."
count number
Number of notifications on the current page.
total number
Total number of notifications.
pageNumber number
The current page number of the paginated response.
Sample Response
PUT - Mark Customer Notifications as Read
The API call is used to mark the customer's notification(s) as read in Gameball.
Security: Requires apikey and secretkey headers.
Request
Body
application/json
notificationsIds array
Required
An array of notification IDs that you want to mark as read. These notification IDs are retrieved through the Get Notifications endpoint, which returns a list of all notifications sent to the customer. By marking specific notifications as read, you acknowledge that the customer has seen them. This is useful for keeping track of which notifications have been addressed and ensuring a clear customer communication experience.
Sample Request
Last updated