POST v1/setup/updateEmailSetup

Request Information

URI Parameters

None.

Body Parameters

updateEmailSetupRequest
NameDescriptionTypeAdditional information
emailSetup

emailSetupItem

None.

Request Formats

application/json, text/json

Sample:
{
  "emailSetup": {
    "emailAddress": "sample string 1",
    "password": "sample string 2",
    "smtpHost": "sample string 3",
    "port": 4,
    "useSSL": true
  }
}

application/xml, text/xml

Sample:
<updateEmailSetupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ntblcpEWORS.Models.emailSetup">
  <emailSetup xmlns:d2p1="http://schemas.datacontract.org/2004/07/ntblcpEWORS.Models">
    <d2p1:emailAddress>sample string 1</d2p1:emailAddress>
    <d2p1:password>sample string 2</d2p1:password>
    <d2p1:port>4</d2p1:port>
    <d2p1:smtpHost>sample string 3</d2p1:smtpHost>
    <d2p1:useSSL>true</d2p1:useSSL>
  </emailSetup>
</updateEmailSetupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

updateEmailSetupResult
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

errorMsg

string

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3"
}

application/xml, text/xml

Sample:
<updateEmailSetupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ntblcpEWORS.Models.emailSetup">
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <success>true</success>
</updateEmailSetupResult>