PUT Method

The HTTP PUT method is used to update the properties of the resource. New settings are specified in a request body.

For example, to change email notification settings, send the following request:

Request:

PUT https://127.0.0.1/api/v7/emailSettings

 

Request Body:

{

 "enabled": false,

 "emailNotificationOptions": [

   "NotifyOnFailure",

   "NotifyOnSuccess",

   "NotifyOnWarning",

   "SuppressNotificationsUntilLastRetry"

 ],

 "emailMessageSettings": {

   "from": "",

   "to": [],

   "subject": "[%JobResult%] %JobName% (%ObjectCount% objects)"

 },

 "smtpSettings": {

   "host": "",

   "port": 25,

   "useSsl": false,

   "authenticationRequired": false,

   "username": ""

 }

}

In case of success, the HTTP PUT method returns the 204 response code in the response.

Page updated 1/4/2024

Page content applies to build 12.7.0.172