Email Accounts

Create a new email account (sending inbox)

IMPORTANT - TWO-STEP VALIDATION PROCESS:

Connection Test (SMTP/IMAP) - Runs FIRST before creating the account. If this fails, the account is NOT created.
Delivery Test (SPF/DKIM/DMARC) - Runs automatically in the background AFTER account creation via EmailEngine webhook.

Flow: • Your request → Connection test (SMTP/IMAP verification) • If connection fails → Error returned, account NOT created • If connection passes → Account created in database • Account registered with EmailEngine → Triggers automatic delivery test • Poll GET /user-api/email-accounts/:id to monitor delivery test progress • Look for accountStatus="ready" AND sendingStatus="ready" to confirm fully operational

Expected Response Time: Connection test: 5-10 seconds. Delivery test: 30-60 seconds (runs in background).

post/v3/user-api/accounts

Request

Base URL
https://api.nureply.com (the document declares no server; this is the origin it was published from)
Auth
none declared. Required headers: x-personal-api-key

Headers

x-personal-api-keystring required

API Key from Dashboard

Request body

addressstring email required

Email address of the account

passwordstring required

Email account password (used for both IMAP and SMTP)

smtpPasswordstring

SMTP password (if different from main password). Required if smtpUsername is provided.

smtpUsernamestring

SMTP username (if different from email address). Optional.

imapServerstring required

IMAP server hostname

imapPortinteger required

IMAP port number (common: 993 for SSL, 143 for TLS)

smtpServerstring required

SMTP server hostname

smtpPortinteger required

SMTP port number (common: 465 for SSL, 587 for TLS, 25 for plain)

senderNamestring required

Display name that appears in the "From" field of sent emails

trackingDomainstring

Custom tracking domain for email opens/clicks. Must be configured with CNAME.

security'TLS' | 'STARTTLS'

Security protocol for connections

dailySendingLimitinteger

Maximum number of emails this account can send per day

signaturestring

Email signature to append to all outgoing emails

maximumWarmUpPerDayinteger

Maximum warmup emails to send per day

minimumWarmUpStartEmailsinteger

Starting number of warmup emails on day 1

warmUpStableDaysinteger

Days to reach maximum warmup volume

enableWarmupboolean

Whether to enable warmup for this account

tagsstring[]

Tags for organizing accounts

Example request

{
  "address": "sender@example.com",
  "password": "securePassword123",
  "smtpPassword": "smtpPassword123",
  "smtpUsername": "sender@example.com",
  "imapServer": "imap.gmail.com",
  "imapPort": 993,
  "smtpServer": "smtp.gmail.com",
  "smtpPort": 465,
  "senderName": "John Doe",
  "trackingDomain": "track.example.com",
  "security": "TLS",
  "dailySendingLimit": 50,
  "signature": "Best regards,<br>John Doe<br>CEO, Example Inc.",
  "maximumWarmUpPerDay": 30,
  "minimumWarmUpStartEmails": 5,
  "warmUpStableDays": 7,
  "enableWarmup": true,
  "tags": [
    "sales",
    "outbound"
  ]
}

Response

messagestring required

Example response

{
  "message": "✅ Email account created successfully! Connection test passed (SMTP/IMAP verified). A delivery test for SPF/DKIM/DMARC verification is now running automatically in the background. Poll the account status endpoint to check when fully ready for sending.",
  "data": {
    "_id": "653a2b0bf5444e11e5cdd1ce",
    "address": "sender@example.com",
    "senderName": "John Doe",
    "imapServer": "imap.example.com",
    "imapPort": 993,
    "smtpServer": "smtp.example.com",
    "smtpPort": 465,
    "security": "TLS",
    "dailySendingLimit": 50,
    "dailySendingLimitRemaining": 35,
    "emailsSentToday": 15,
    "trackingDomain": "track.example.com",
    "trackingDomainStatus": "active",
    "accountStatus": "ready",
    "sendingStatus": "ready",
    "accountHealth": 95,
    "warmUpDetails": {
      "maximumWarmUpPerDay": 30,
      "minimumWarmUpStartEmails": 5,
      "warmUpStableDays": 7,
      "warmUpPerDayRemaining": 30,
      "warmUpStartDate": "2023-10-20T10:30:35.624Z"
    },
    "dkimDetails": {
      "status": "pass",
      "message": "DKIM authentication passed"
    },
    "spfDetails": {
      "status": "pass",
      "message": "DKIM authentication passed"
    },
    "dmarcDetails": {
      "status": "pass",
      "message": "DKIM authentication passed"
    },
    "tags": [
      "sales",
      "outbound"
    ],
    "signature": "Best regards,<br>John Doe",
    "createdAt": "2023-10-26T10:30:35.624Z",
    "updatedAt": "2023-10-26T10:30:35.624Z",
    "id": "653a2b0bf5444e11e5cdd1ce",
    "connectionTest": {
      "status": "pass",
      "message": "SMTP and IMAP connections verified successfully",
      "imapVerified": true,
      "smtpVerified": true
    },
    "deliveryTest": {
      "status": "running_in_background",
      "message": "Delivery test (SPF/DKIM/DMARC verification) is running automatically via EmailEngine webhook. Poll the account details endpoint to monitor progress.",
      "instructions": {
        "step1": "Poll GET /user-api/email-accounts/653a2b0bf5444e11e5cdd1ce every 10-15 seconds",
        "step2": "Look for accountStatus=\"ready\" AND sendingStatus=\"ready\"",
        "step3": "Check dkimDetails.status, spfDetails.status, dmarcDetails.status (should all be \"pass\")",
        "step4": "If status shows \"deliveryWarning\", check the error messages in dkimDetails/spfDetails/dmarcDetails for DNS configuration instructions"
      },
      "expectedDuration": "30-60 seconds"
    }
  }
}

Changes

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