Sender Emails

Connect an SMTP/IMAP sender email

Connects an SMTP/IMAP mailbox to the workspace using an app password, with no browser step. Google and Microsoft mailboxes are not supported here because both require an interactive consent screen; connect those in the app. The address must be a business domain.

post/sender-emails

Request

  • Base URL: https://api.emailchaser.com/r
  • URL: https://api.emailchaser.com/r/sender-emails
  • Auth: HTTP bearer

Request body

emailstring required
firstNamestring
imapServerUrlstring required

ImapServerUrl and SmtpServerUrl accept the provider's host, optionally with a port, for example "imap.fastmail.com:993".

lastNamestring
loginStringstring

LoginString defaults to the email address when omitted, which is what most providers expect.

passwordstring required
smtpServerUrlstring required

Response

Sender email connected successfully

messagestring

Example response

{
  "message": "sender email connected successfully",
  "senderEmail": {
    "address": "john@example.com",
    "campaignIds": [
      1,
      2,
      3
    ],
    "connectionHistory": [
      {
        "campaignId": 10,
        "createdAt": "2024-01-15T10:30:00Z",
        "disconnectionReason": "token_expired",
        "errorCode": "AUTH_FAILED",
        "errorMessage": "Token has expired",
        "eventType": "disconnected",
        "id": 456,
        "userId": 5
      }
    ],
    "createdAt": "2024-01-10T10:30:00Z",
    "currentDailyLimit": 35,
    "errorCode": "AUTH_FAILED",
    "errorMessage": "Authentication failed",
    "familyName": "Doe",
    "givenName": "John",
    "healthScore": 96,
    "id": 123,
    "isConnected": true,
    "lastDisconnectedAt": "2024-01-15T10:30:00Z",
    "lastReconnectedAt": "2024-01-16T09:00:00Z",
    "maximumSendingsLimitPerDay": 50,
    "minimumSendingsLimitPerDay": 20,
    "pictureUrl": "https://example.com/avatar.jpg",
    "provider": "google",
    "provisioningStatus": "complete",
    "signature": "Best regards,\nJohn Doe",
    "toggleGradualBuildUp": true,
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Changes

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