Graph API Version

User Notifications

Reading

You can't perform this operation on this endpoint.

Creating

You can make a POST request to notifications edge from the following paths:
When posting to this edge, no Graph object will be created.

Parameters

ParameterDescription
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.

title
string

title

Required
body
string

body

Required
media_url
URI

media_url

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

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
notification_id: int32,
}

Error Codes

ErrorDescription
288Sending notificatons to user requires the extended permission app_notifications
100Invalid parameter
613Calls to this api have exceeded the rate limit.
368The action attempted has been deemed abusive or is otherwise disallowed
200Permissions error
190Invalid OAuth 2.0 Access Token

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.