Skip to main content

Update the email settings

PUT 

/api/v1/Email/settings/:id

Replaces the email settings with the values in the request body and returns them. Use it to set the mail server, sender address and credential. The path ID must belong to an existing record; the record that is saved is the one named by the id in the body.

Permission required: Admin role (or the App role).

Caution: The new values take effect immediately for email that uses these settings.

Request​

Responses​

The settings were updated. The body is the settings as sent, with the modified time set.