notifications/send
The following methods are supported on this resource:
Mount Points
The following URLs are examples of where this resource is mounted :
| XML: | http://api.hi5.com |
| *JSON: | http://api.hi5.com |
| *JSON endpoints are mounted read-only. | |
read
Sends a hi5 Notification with the specified text body to a set of users. Users to be sent to are specified as a list of userids, passed in via the toIds parameter.
The number of emails sent is limited by quotas. See the Platform Wiki for more information.Possible HTTP Parameters
| name | description |
|---|---|
| body | The text body of the notification. Only a and br tags are currently allowed, any other html is filtered. |
| toIds | List of hi5 userids to attempt to send the notification to. This should be passed in as multiple params (i.e. toIds=1000&toIds=2000&toIds=3000...) A maximum of 200 ids are allowed or the request will fail with an error. Only users who are friends with the sender as identified from the auth token, or who have the sending application installed, will receive the notification. A list of ids for users who have successfully received the notification will be returned in the response. |
Output Payload
NotificationResponse Response with error_code and error_message set if there is a global error. sent_ids set if any notifications are successfully sent
Errors
| code | description |
|---|---|
| 503 | if the application violates Hi5's internal constraints. |
| 403 |
update
Sends a hi5 Notification with the specified text body to a set of users. Users to be sent to are specified as a list of userids, passed in via the toIds parameter.
The number of emails sent is limited by quotas. See the Platform Wiki for more information.Possible HTTP Parameters
| name | description |
|---|---|
| body | The text body of the notification. Only a and br tags are currently allowed, any other html is filtered. |
| toIds | List of hi5 userids to attempt to send the notification to. This should be passed in as multiple params (i.e. toIds=1000&toIds=2000&toIds=3000...) A maximum of 200 ids are allowed or the request will fail with an error. Only users who are friends with the sender as identified from the auth token, or who have the sending application installed, will receive the notification. A list of ids for users who have successfully received the notification will be returned in the response. |
Output Payload
NotificationResponse Response with error_code and error_message set if there is a global error. sent_ids set if any notifications are successfully sent
Errors
| code | description |
|---|---|
| 503 | if the application violates Hi5's internal constraints. |
| 403 |