Notifies one or more users via Email.
There are 2 ways to use this API –
- By passing Email Addresses –
Pass only the “UserEmailAddresses” and keep the “Roles” parameter empty. This way you’ll notify only the users whose email addresses you passed.
- By passing User Roles –
Pass only the “Roles” and keep the “UserEmailAddresses” parameter empty. This way you’ll notify all users within a role.
Provide the following details:
For the parameter “Content HTML”, you must use a valid JSON data format to pass the HTML content in the email body. For example –
“<h1>Hello There, </h1>
Valid user email addresses.
Valid user roles. Accepted values are
HTTP Response Codes
This is the status code for successful API call.
The API call was made with invalid access credentials. Check your AccessKey and SecretKey.
|400 Bad Request||
The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.
|404 Not Found||
The API could not be found. Please check the API signature.
|429 Too Many Requests||
API calls exceeded the limit of 25 in 5 second(s)
|500 Internal Server Error||
The API called failed. There could be many reasons for it. Check the exception message to get more details.