Communication
Manages email, sms, push notifications sent to users
"Notification are the important alerts that appear on top right corner of the platform. These will generally display any alerts that you wish to highlight to Platform users of company and sales channel like store is verified. This resource allows you to edit notification related information such as its content and appearance, and moreover schedule it to appear on platform."
Operations
GET
# Get system notifications.
Parameters
company_id
string
Required
Company id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Success
SystemNotifications
items
array of object (SystemNotification)
Array of SystemNotification
notification
object (Notification)
Notification
title
string
body
string
subtitle
string
icon
string
deeplink
string
click_action
string
user
object (SystemNotificationUser)
SystemNotificationUser
type
string
value
string
settings
object (SystemNotificationSetting)
SystemNotificationSetting
sound
boolean
priority
string
time_to_live
string
_id
string
group
string
created_at
string
| date-time
last_read_anchor
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
Was this section helpful?
GET
Response