Update Mail Notification Settings

Update Mail Notification Settings

Perform the update over the existing mail notification settings.

Request
URI
PUT
https://{api_host}/mail-notifications
COPY
Request Body
MailNotifications of type(s) application/json
Required 
{
    "notificationSettings": {
        "fromEmail": "string",
        "notifyEmails": [
            "string"
        ],
        "notificationFrequency": 0
    },
    "alertsSubscriptions": [
        "string"
    ],
    "lastModificationTime": 0,
    "paused": false,
    "smtpSettings": {
        "smtpHost": "string",
        "smtpPort": 0,
        "smtpUser": "string",
        "smtpPassword": "string",
        "smtpUseSsl": false
    }
}
NotificationSettings
notificationSettings
Required

notificationSettings

array of string
alertsSubscriptions
Required

alertsSubscriptions

Possible values are : PRODUCT_NOTIFICATIONS, RESOURCE_USAGE, CLOUD_CONNECTION, DATA_FILE_MANAGEMENT,
integer
lastModificationTime
Optional

lastModificationTime

boolean
paused
Optional

paused

SmtpSettings
smtpSettings
Required

smtpSettings

Responses
204

Mail notification settings are updated successfully.

Operation doesn't return any data structure

400
Returns 400InvalidRequestValidationIssues of type(s) application/json 
{
    "messages": [
        {
            "errMessage": "Provide Notify email(s) value.",
            "errCode": "notifications.notifyEmails.missing"
        },
        {
            "errMessage": "SMTP Password is required.",
            "errCode": "smtp.password.missing"
        },
        {
            "errMessage": "Select at least one type of alert.",
            "errCode": "alerts.missing"
        }
    ]
}
array of Error
messages
Optional

Validation errors response object.


401
Returns 401Unauthorized_sessionID of type(s) application/json 
{
    "errCode": "GW_LOGIN_REQUIRED",
    "errMessage": "Your session not found or already expired. Please login"
}
string
errCode
Optional

errCode

string
errMessage
Optional

errMessage


On This Page
Mail Notification Settings Operations
DELETE
Delete Mail Notification Settings
GET
Get Mail Notification Settings
PATCH
Patch Mail Notification Settings
PUT
Update Mail Notification Settings