Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Email Accounts

Create an email account

<small>Requires the channels:write scope (or a broader one that includes it).</small>

Creates a new email account. Only works with custom email account providers (SMTP/IMAP).

post/v3/email-accounts

Request body

tagsstring[]

Tag names to assign to the new email account

Example request

{
  "connection": {
    "email": "sales@company.com",
    "senderName": "Sales Team",
    "smtpHost": "smtp.company.com",
    "smtpPort": 465,
    "smtpPassword": "secret123",
    "smtpSsl": true,
    "imapHost": "imap.company.com",
    "imapPort": 993,
    "imapPassword": "secret123",
    "imapSsl": true
  },
  "safety": {
    "dailyLimit": 500
  },
  "signature": {
    "signature": "Best regards,\nSales Team"
  },
  "optOut": {
    "isOptOutLinkEnabled": true,
    "optOutTextBlock": "Unsubscribe here"
  },
  "rampUp": {
    "enabled": false,
    "startValue": 10,
    "incrementValue": 5
  },
  "tags": [
    "Outbound"
  ]
}

Response

Email account created successfully

idinteger

Unique identifier for the email account

ownerUserIdinteger

ID of the user who owns this email account

emailAccountType'custom' | 'gmail' | 'outlook' | 'exchange' | 'exchangeOnPremise'

Provider type of the email account. Values: custom, gmail, outlook, exchange, exchangeOnPremise

isDefaultboolean

Whether this is the user's default email account

isInUseboolean

Whether this email account is currently used in any active sequence

connectionStatus'unknown' | 'connected' | 'disconnected'

Current connection status of the email account. Values: unknown, connected, disconnected

sendingConnectivityErrorstring nullable

Error details if SMTP sending connectivity has failed

receivingConnectivityErrorstring nullable

Error details if IMAP receiving connectivity has failed

sendingLockedByProviderboolean

Whether the email provider has locked outbound sending

updatedAtstring date-time

Timestamp of the last update to this email account

tagsstring[]

Tag names associated with this email account

Example response

{
  "id": 12345,
  "ownerUserId": 42,
  "emailAccountType": "custom",
  "isDefault": false,
  "isInUse": true,
  "connectionStatus": "connected",
  "sendingConnectivityError": null,
  "receivingConnectivityError": null,
  "sendingLockedByProvider": false,
  "updatedAt": "2026-03-15T10:30:00Z",
  "connection": {
    "email": "john.doe@company.com",
    "senderName": "John Doe",
    "smtpHost": "smtp.company.com",
    "smtpPort": 465,
    "smtpSsl": true,
    "imapHost": "imap.company.com",
    "imapPort": 993,
    "imapSsl": true
  },
  "safety": {
    "dailyLimit": 500,
    "isEmailsThrottlingEnabled": true,
    "emailsPerInterval": 5,
    "emailsThrottlingSecondsInterval": 60,
    "isSendingDelayEnabled": true,
    "maxSendingDelaySeconds": 120,
    "minSendingDelaySeconds": 30
  },
  "signature": {
    "signature": "Best regards,\nJohn Doe"
  },
  "optOut": {
    "message": "Unsubscribe",
    "emailFooter": "",
    "isOptOutLinkEnabled": true,
    "optOutTextBlock": "Click here to unsubscribe"
  },
  "rampUp": {
    "enabled": false,
    "startValue": 10,
    "incrementValue": 5
  },
  "tags": [
    "Marketing"
  ]
}