User Notifications
Reading
Creating
notifications
edge from the following paths:
Parameters
| Parameter | Description |
|---|---|
bot_message_payload_elements
string
|
Optional bot message payload used for sending a customizable generic template XMA to the recipient if a bot message is sent. If not specified, then a standard generic template XMA will be sent using just the message title and body. |
filtering
list<enum{groups, groups_social, ema}>
|
Notification filters to apply. |
href
|
The relative path and GET params used in the a2u target url. |
label
string
|
Optional label to group similar updates. |
message
JSON object
|
Contains the title, main message body, and media image for the notification. |
notif_ids
list<string>
|
The notification ids to act on. |
payload
string
|
Optional custom payload that will be added to the URL encoding of the game that is generated when the notification is clicked. |
read
boolean
|
Indicates that the provided notification ids should be marked as read |
ref
string
|
A reference param used for logging |
schedule_interval
int64
|
Time from now (in seconds) that the notification will be sent |
seen
boolean
|
Indicates that the provided notification ids should be marked as seen |
template
|
Used for creating a2u notifications. Supports Emoji
|
type
enum{generic, content_update}
|
Notification type |
Return Type
success
: bool,notification_id
: int32,Error Codes
| Error | Description |
|---|---|
| 613 | Calls to this api have exceeded the rate limit. |
| 288 | Sending notificatons to user requires the extended permission app_notifications |
| 100 | Invalid parameter |
| 200 | Permissions error |
| 368 | The action attempted has been deemed abusive or is otherwise disallowed |
| 190 | Invalid OAuth 2.0 Access Token |
