PUT /system-ms/email-server

Update the Email server.

Note: Only admin user is allowed to update Email server configuration details.
To modify the Email server:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use PUT /system-ms/email-server to send an HTTP PUT request.

  3. Click Try it Out option.

  4. Under Request body select application/json from drop-down list.

  5. Enter the request body parameter values as follows:
    {
  "smtpServer": "string",
  "port": 0,
  "userID": "string",
  "password": "string",
  "emailAddress": "string"
}

    See POST /system-ms/email-server for the request body parameters.

  6. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/system-ms/email-server
    The following table lists the expected responses.

    Response Type

    Value

    Schema
    Valid Response

    200 OK
    For 200 OK, 
    {
  "passwordStrength": "string",
  "minimumPasswordLength": 0,
  "maximumPasswordLength": 0,
  "passwordExpirationPeriod": 0,
  "daysBeforeExpire": 0
}

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: Email Server
↑