Update SMTP settings - PUT /SMTPSettings/{id}

Update SMTP settings according to SMTP Settings Id.

The ‘Manage System Settings’ permission is required to execute this API.


  1. PUT /SMTPSettings/{id} and update the SMTP settings
  2. POST /SMTPSettings/testconnection and test SMTP connection





Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0



id=[integer] - Unique Id of the SMTP settings

updateSMTPSettingsModel=[body]: Specifies the SMTP settings to update
password=[string] - Sender password
host=[string] - SMTP server host
port=[integer] - Port for sending emails
encryptionType=[string] - SMTP encryption type (SSL,TLS or None)
fromAddress=[string] - From field when sending emails
useDefaultCredentials=[string] - Whether SMTP communication is done via SSL (true/false)
username=[string] - Sender user name

Success Response:

Code: 204 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found

Sample Response:

no content


Updates the SMTP settings according to the defined parameters. Once the request is successful, it does not return any content. If the request fails, it returns an error response.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to usWe appreciate your feedback!