Get SMTP Settings by Id - GET /SMTPSettings/{id}



Get details of SMTP settings according to SMTP Settings Id.

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

Usage:

  1. GET /SMTPSettings/{id} and get details of SMTP settings
  2. PUT /SMTPSettings/{id} and update SMTP settings

URL

/cxrestapi/auth/SMTPSettings/{id}

Method:

GET

Media Type (header):

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

Parameters

Required:

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

Success Response:

Code: 200 Success

Error Response:

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

Sample Response:

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

Notes:

Retrieves details of the SMTP settings according to the specified SMTP settings Id. 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!