Get All SMTP Settings - GET /SMTPSettings



Get details of all SMTP settings.

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

Usage:

  1. GET /SMTPSettings and get details of all SMTP settings

  2. /wiki/spaces/CCD/pages/712999010 and update SMTP settings

URL

/cxrestapi/auth/SMTPSettings

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

[
  {
    "id": 1,
    "host": "pod55017.outlook.com",
    "port": 521,
    "encryptionType": "Tls",
    "fromAddress": "noreply@check.org",
    "useDefaultCredentials": false,
    "username": "noreply@check.org"
  }
]

Notes:

Retrieves SMTP setting details. 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!