Notifications
Listed below are all the notification methods, along with their parameters, filters, and includes.
All parameters that contain (*) are required.
User Notifications
Returns all notifications from the user, or
Noneif user has no messages.
If the user ID does not exist, an error is returned.
id: int -> The user ID. *
Notification Details
Returns a dict containing the notification information, or an error if the user ID or notification ID does not exist.
id: int -> The user ID. *
notification_id: str -> The notification ID. *
Send Notification To All Users
Returns a dict containing the sent message informations.
title: str -> The title of the message. *
content: str -> The content of the message. *
via: str -> The way in which users will receive the message. Available Methods: ['mail', 'database']. *
If the shipping method chosen is mail, and it is not working correctly on your server, an error will be returned.
Send Notification To Specific Users
Returns a dict containing the sent message informations.
title: str -> The title of the message. *
content: str -> The content of the message. *
users: list -> The user ID's that will receive this message. *
via: str -> The way in which users will receive the message. Available Methods: ['mail', 'database']. *
If the shipping method chosen is mail, and it is not working correctly on your server, an error will be returned.
Delete All Notifications
Returns a dict containing the information of the user deleted messages.
id: int -> The user ID. *
Delete Notification
Returns a dict containing the information of the deleted message.
id: int -> The user ID. *
notification_id: str -> The notification ID. *