Patch Mail Notification Settings

Patch Mail Notification Settings

Apply a collection of patch instructions (updates) against the existing mail notification settings.

Request
URI
PATCH
https://{api_host}/mail-notifications
COPY
Request Body
Array of PatchInstruction of type(s) application/json-patch+json
Optional 
[
    {
        "op": "string",
        "path": "string",
        "from": "string"
    }
]
Responses
204

Mail notification settings are patched successfully.

Operation doesn't return any data structure

304

Mail Notification settings does not exist.

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