Mailboxes

Connect mailbox

Connect an SMTP/IMAP mailbox to the workspace. Send the outgoing server credentials under "smtp" and the incoming server credentials under "imap". Both are verified against the mail provider before anything is stored, so a bad host, port or password fails with 400 and creates nothing; the message names the failing protocol and, where the reason is recognized (wrong credentials, unreachable host, TLS mismatch, ...), a short cause. On success the mailbox is returned with status "pending": registration with the mail infrastructure finishes moments later and flips it to "active", or to "access_lost" if it fails. Poll GET /workspaces/{workspaceID}/mailboxes/{mailboxID} to observe the final status. Connecting is idempotent by address: a second request for an address already mid-connect returns 409 instead of racing the first. Google and Outlook mailboxes connect through /mailboxes/oauth-link instead.

post/workspaces/{workspaceID}/mailboxes

Request

Base URL
https://api.salesforge.ai/public/v2
Auth
API key in header Authorization

Path parameters

workspaceIDstring required

Workspace ID

Request body

object required

Example request

{
  "address": "jane@example.com",
  "dailyEmailLimit": 30,
  "firstName": "Jane",
  "imap": {
    "host": "mail.example.com",
    "port": 587,
    "username": "jane@example.com"
  },
  "lastName": "Doe",
  "smtp": {
    "host": "mail.example.com",
    "port": 587,
    "username": "jane@example.com"
  },
  "trackingDomain": "track.example.com"
}

Response

Mailbox

addressstring

dailyEmailLimitinteger

disconnectReasonstring

firstNamestring

idstring

lastNamestring

mailboxProvider'gmail' | 'outlook' | 'smtp'

resolvedSignaturestring

signaturestring

trackingDomainstring

trackingDomainStatus'active' | 'pending'

Changes

No recorded changes to this operation across all 1 revision of this API.