Skip to main content

Test Email Credentials for dealer​

Test Email Credentials for dealer

Path Parameters
    dealerUUID string required
Request Body required
    emailCredentialsRequests object[]
  • Array [
    • imapUserID string
    imapHost string
    imapPort string
    smtpUserID string
    smtpPassword string
    smtpHost string
    smtpPort string
    smtpEnableStartTLS string
    smtpUseAuth string
    imapUseSSLOrTLS string
    imapEnableStartTLS string
    smtpUseSSLOrTLS string
    dealerEmail string
    accountType string
    password string
    orgName string
    credentialsType string
    imapPassword string
  • ]
Responses

OK

Schema
    emailCredentialsResponses object[]
  • Array [
    • serverLogs string
    outcome string
    testDuration string
    credentialsType string
    error string
    password string
    imaphost string
    imapport string
    smtpuserID string
    smtppassword string
    smtphost string
    smtpport string
    smtpuseSSLOrTLS string
    smtpenableStartTLS string
    smtpuseAuth string
    imapuseSSLOrTLS string
    imapenableStartTLS string
    accountType string
    imapuserID string
    imappassword string
    dealerEmail string
    errors object[]
  • Array [
    • errorCode string
    errorDescription string
    errorUID string
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
  • ]
    • errors object[]
  • Array [
    • errorCode string
    errorDescription string
    errorUID string
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
POST /dealers/:dealerUUID/email-credentials/test

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/communications
Username
Password
dealerUUID — path required
Body required
{

  "emailCredentialsRequests": [

    {

      "imapUserID": "string",

      "imapHost": "string",

      "imapPort": "string",

      "smtpUserID": "string",

      "smtpPassword": "string",

      "smtpHost": "string",

      "smtpPort": "string",

      "smtpEnableStartTLS": "string",

      "smtpUseAuth": "string",

      "imapUseSSLOrTLS": "string",

      "imapEnableStartTLS": "string",

      "smtpUseSSLOrTLS": "string",

      "dealerEmail": "string",

      "accountType": "string",

      "password": "string",

      "orgName": "string",

      "credentialsType": "string",

      "imapPassword": "string"

    }

  ]

}
curl / cURL
curl -L -X POST '/communications/dealers/:dealerUUID/email-credentials/test' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "emailCredentialsRequests": [
    {
      "imapUserID": "string",
      "imapHost": "string",
      "imapPort": "string",
      "smtpUserID": "string",
      "smtpPassword": "string",
      "smtpHost": "string",
      "smtpPort": "string",
      "smtpEnableStartTLS": "string",
      "smtpUseAuth": "string",
      "imapUseSSLOrTLS": "string",
      "imapEnableStartTLS": "string",
      "smtpUseSSLOrTLS": "string",
      "dealerEmail": "string",
      "accountType": "string",
      "password": "string",
      "orgName": "string",
      "credentialsType": "string",
      "imapPassword": "string"
    }
  ]
}'