API Guide

new_object_id string
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
STATUS CODE - default: Response to a get SMTP conguration request
RESPONSE MODEL - application/json
{
SMTP conguration object
smtp_host* string
SMTP Host
port* integer
Port
from_email_id* string
Email id from which notications will be sent
username string
Username of account
password string
Password of account
auth_required* boolean
Is authentication required?
ssl_required* boolean
Is SSL required?
}
19.3 PUT /notifications/smtp
Apply the specied SMTP conguration.
This API applies the SMTP conguration provided in 'conguration', if valid. This will be used for sending notication
emails.
REQUEST
REQUEST BODY - application/json
{
SMTP conguration object
smtp_host* string
SMTP Host
port* integer
Port
from_email_id* string
Email id from which notications will be sent
username string
Username of account
password string
Password of account
auth_required* boolean
Is authentication required?
ssl_required* boolean
Is SSL required?
}
RESPONSE
STATUS CODE - 200: Response to a notication request
RESPONSE MODEL - application/json
{
Notication Request Status object
status enum ALLOWED:SUCCESS, FAILURE
Status of the request
247 of 340