Create SMTP Settings - POST /SMTPSettings
Create new SMTP settings.
The ‘Manage System Settings’ permission is required to execute this API.
Usage:
- POST /SMTPSettings and create new SMTP settings
- POST /SMTPSettings/testconnection and test SMTP connection
URL
/cxrestapi/auth/SMTPSettings
Method:
POST
Media Type (header):
Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0
Parameters
createSmtpSettingsModel=[body]: Specifies the SMTP setting details
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: 201 Success
Error Response:
Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Sample Response:
no content
Notes:
Returns the location of the created SMTP settings in the response header. 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 us. We appreciate your feedback!