SAsaleshandy
email-accounts

Connect an SMTP/IMAP email account

Connects a new SMTP/IMAP email account for use as a sending mailbox in sequences.

The account is always saved to the database, even if the connection test fails — inspect the smtpConnection and imapConnection fields in the response.

  • status: 0 — created but connection unverified (check smtpConnection.error/imapConnection.error).
  • status: 1 — connected and verified.

emailServiceProvider must be lowercase (e.g. "zoho"). Valid values: zoho, gmail, yahoo, sendgrid, mailgun, ses, outlook.

fromName is the full display name shown in the From header; it is independent of fromFirstName/fromLastName — all three must be supplied.

post/v1/email-accounts/smtp-imap/connect

Request

Request body

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

Email service provider identifier. Accepted values: gmail, microsoft, gsuite, o365, yahoo, zoho, godaddy, yandex, sendgrid, other.

fromNamestring required

Full display name shown as the sender.

fromFirstNamestring required

Sender's first name.

fromLastNamestring required

Sender's last name.

Example request

{
  "emailServiceProvider": "zoho",
  "fromName": "Sarah Chen",
  "fromFirstName": "Sarah",
  "fromLastName": "Chen",
  "payload": {
    "smtp": {
      "emailAddress": "sarah.chen@outreach.io",
      "password": "AppPassword123",
      "host": "smtp.zoho.com",
      "port": 587,
      "encryption": "TLS",
      "userName": "sarah.chen@outreach.io"
    },
    "imap": {
      "emailAddress": "sarah.chen@outreach.io",
      "password": "AppPassword123",
      "host": "imap.zoho.com",
      "port": 993,
      "encryption": "SSL"
    }
  }
}

Response

Email account connected successfully

Changes

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