message/sendEmails
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 an email with the specified text title and 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 |
|---|---|
| title | the subject for the email. No html is allowed. |
| body | the body of the email message. Only a and br tags are allowed, any other html is filtered. |
| toIds | List of hi5 userids to attempt to send the email 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 have the sending application installed will receive the email. A list of ids for users to whom the email was successfully sent is set in the response. |
Output Payload
EmailResponse Response with error_code and error_message set if there is a global error. sent_ids set if any emails are successfully sent
Errors
| code | description |
|---|---|
| 503 | |
| 403 | if the auth token is not valid |
update
Sends an email with the specified text title and 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 |
|---|---|
| title | the subject for the email. No html is allowed. |
| body | the body of the email message. Only a and br tags are allowed, any other html is filtered. |
| toIds | List of hi5 userids to attempt to send the email 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 have the sending application installed will receive the email. A list of ids for users to whom the email was successfully sent is set in the response. |
Output Payload
EmailResponse Response with error_code and error_message set if there is a global error. sent_ids set if any emails are successfully sent
Errors
| code | description |
|---|---|
| 503 | |
| 403 | if the auth token is not valid |