Route: https://api.kayran.live/UpdateMailNotify
Use this function to edit everything related to receiving notifications to your mail regarding your scans.
Roles Required: Admin.
Request Syntax
{
"apiKey": "String",
"mailCompleted": on|off,
"mailStop": on|off,
"mailPause": on|off,
"mailUnpause": on|off,
"mailDelete": on|off,
"mailStatus": on|off,
"mailQueue": on|off,
"mailSchedule": on|off,
"mailAborted": on|of
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
mailPause
Parameter Usage and Options :
If you wish to get notified on scans that were Paused.
Type :
String – on | off
Is it Optional ? :
No.
Parameter Name :
mailUnpause
Parameter Usage and Options :
If you wish to get notified on Paused scans that were Resumed/Unpaused.
Type :
String – on | off
Is it Optional ? :
No.
Parameter Name :
mailDelete
Parameter Usage and Options :
If you wish to get notified on scans that were Deleted.
Type :
String – on | off
Is it Optional ? :
No.
Parameter Name :
mailStatus
Parameter Usage and Options :
If you wish to get notified on scans that their Status were changed.
Type :
String – on | off
Is it Optional ? :
No.
Parameter Name :
mailQueue
Parameter Usage and Options :
If you wish to get notified on Queued scans that were initiated.
Type :
String – on | off
Is it Optional ? :
No.
Parameter Name :
mailSchedule
Parameter Usage and Options :
If you wish to get notified on Scheduled scans that were initiated.
Type :
String – on | off
Is it Optional ? :
No.
Parameter Name :
mailAborted
Parameter Usage and Options :
If you wish to get notified on scan that were Aborted.
Type :
String – on | off
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "UpdateMailNotify",
"Data": "Update"
}Errors and their Possible Causes
For more information, please refer to the General Errors section.