SAsaleshandy
email-accounts

Connect new sending email accounts with SMTP and IMAP settings

This can be a large request and may take some time to complete. But you will get response immediately after the request is submitted.

On request of this API, you will receive a requestId that can be used to check the status of the import process.

To check the status of the import process, you can use the /v1/email-accounts/connect/status API.

After completion you will receive a CSV file link containing the email account import details.

post/v1/email-accounts/connect

Request

Request body

emailServiceProvider'gsuite' | 'microsoft' | 'o365' | 'yahoo' | 'zoho' | 'godaddy' | 'yandex' | 'sendgrid' | 'other' required

Email service provider : gsuite, microsoft, o365, yahoo, zoho, godaddy, yandex, sendgrid, other

fromFirstNamestring required

First name of the sender

fromLastNamestring required

Last name of the sender

smtpEmailAddressstring required

SMTP email address

smtpUserNamestring required

SMTP username

smtpPasswordstring required

SMTP password

smtpHoststring required

SMTP host

smtpPortnumber required

SMTP port

smtpEncryption'ssl' | 'tls' | 'none' required

SMTP encryption type (SSL/TLS/NONE)

imapEmailAddressstring required

IMAP email address

imapUserNamestring required

IMAP username

imapPasswordstring required

IMAP password

imapHoststring required

IMAP host

imapPortnumber required

IMAP port

imapEncryption'ssl' | 'tls' | 'none' required

IMAP encryption type (SSL/TLS/NONE)

Example request

[
  {
    "emailServiceProvider": "gsuite",
    "fromFirstName": "John",
    "fromLastName": "Snow",
    "smtpEmailAddress": "john@example.com",
    "smtpUserName": "john@example.com",
    "smtpPassword": "smtp-password",
    "smtpHost": "smtp.gmail.com",
    "smtpPort": 465,
    "smtpEncryption": "ssl",
    "imapEmailAddress": "john@example.com",
    "imapUserName": "john@example.com",
    "imapPassword": "imap-password",
    "imapHost": "imap.gmail.com",
    "imapPort": 993,
    "imapEncryption": "ssl"
  }
]

Response

The email accounts connection process has been initiated successfully. Please wait while we connect your email accounts. You may check the status using this API /v1/email-accounts/connect/status/{{requestId}}.

unknown required

Example response

{
  "message": "The email accounts connection process has been initiated successfully. Please wait while we connect your email accounts. You may check the status using this API `/v1/email-accounts/connect/status/{{requestId}}`.",
  "payload": {
    "requestId": "129a184"
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.