This is an archive version of the document. To get the most up-to-date information, see the current version.

Editing Notification Settings

You can edit email notification settings.

Request

PUT https://<hostname>:4443/v5/VBOEmailSettings

Request Headers

The request header must contain an authorization token of the current session.

Request Body

To edit email notification settings, you need to enter in the request body the required properties with new values. The properties you omit will remain unchanged.

The following table lists available request properties:

Property	Type	Description
enableNotification	boolean	If set to true, indicates that Veeam Backup for Microsoft Office 365 will send email notifications on the job run results.
smtpServer	string	Specifies the full DNS name or IP address of the SMTP server for sending email notifications.
port	integer	Specifies the port for connecting to the SMTP server.
useAuthentication	boolean	If set to true, indicates that SMTP server requires authentication. Otherwise, the connection will be established to SMTP server, which does not enforce authentication.
username	string	Specifes the user name for authenticating with the SMTP server.
userpassword	string	Specifies the password for authenticating with the SMTP server.
useSSL	boolean	If set to true, indicates that Veeam Backup for Microsoft Office 365 will use a secure connection for email notification transmission. Otherwise, email notifications will be transmitted through the connection that does not require SSL authentication.
from	string	Specifies notification sender mailbox email address with the rights to connect to the SMTP server.
to	string	Specifies notification recipient mailbox email address. Semicolon is used for listing multiple recipients.
subject	string	Specifies the subject that must be used for creating a notification email. The subject of an email notification displays information according to the following variables: %JobName% - backup job name %JobResult% - backup job result %OrgName% - the organization, whose mailboxes were processed by the backup job %objectCount% - total number of processed items %Issues% - number of objects processed with Failed or Warning status %Time% - date and time of the backup job completion
notifyOnSuccess	boolean	If set to true, Veeam Backup for Microsoft Office 365 will send a notification message after a backup job completes its session without any warnings or errors.
notifyOnWarning	boolean	If set to true, Veeam Backup for Microsoft Office 365 will send a notification message if the job finishes with warnings.
notifyOnFailure	boolean	If set to true, Veeam Backup for Microsoft Office 365 will send a notification message if the job finishes with errors.
supressUntilLastRetry	boolean	If set to true, Veeam Backup for Microsoft Office 365 will send a notification message according to the job schedule options. The following email notification scenarios are possible: If the job fails, Veeam Backup for Microsoft Office 365 will send a notification message on the last job retry If the job completes with Success or Warning, Veeam Backup for Microsoft Office 365 will send a notification message on the last completion status If the job is scheduled to Terminate job if it runs longer than <interval>, Veeam Backup for Microsoft Office 365 will send a notification message on the last attempt within that interval
attachDetailedReport	boolean	If set to true, Veeam Backup for Microsoft Office 365 will attach a report about the job results to the email notification.

For example:

Request Body:

{

"enableNotification": true,

"smtpServer": "smtp.office365.com",

"port": 590,

"useAuthentication": true,

"username": "johnsmith@tech.onmicrosoft.com",

"useSSL": true,

"from": "support@tech.com",

"to": "qa@tech.com",

"subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes)",

"notifyOnSuccess": false,

"notifyOnWarning": false,

"notifyOnFailure": false,

"supressUntilLastRetry": true,

"attachDetailedReport": true

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

Examples

Example 1

The example shows how to update email notification settings.

Request:

PUT https://abc.tech.local:4443/v5/VBOEmailSettings

Request Header:

Authorization: Bearer <Access-Token>