Mailboxes & Domains

Mailboxes

PATCH /mailboxes/:id fields: dailySendCap (max 20), smtpHost, smtpPort, imapHost, imapPort, smtpUsername, smtpPassword, sendingEnabled, assumedWarm, signatureHtml, senderName, warmupGroup.

warmupGroup splits one workspace into separate warmup networks: a mailbox only ever warms with mailboxes of its own workspace and group, plus the Sendbox seed pool. Leave it unset (or send null) for the workspace’s default network.

PUT /mailboxes/by-email/:email body: appPassword (required; spaces are ignored), senderName, tagIds (mailbox tags, added, never removed), warmupGroup. The app password is checked against smtp.gmail.com first; if Google refuses it nothing is saved (400, or 502 if Google could not be reached). Returns the mailbox row plus created: 201 when it was created, 200 when an existing mailbox’s login was replaced (its warmup and history are kept). Safe to repeat.

POST /mailboxes/:id/start-warmup fields (all optional, falling back to your workspace’s saved preset for that provider type, then a sane default): startingVolume, dailyIncrease, targetVolume, replyRateMinPct, replyRateMaxPct. Starting a mailbox that is already warming restarts its ramp at day 0.

An address warms in one workspace only. Starting or resuming warmup for an address that is already warming in another workspace returns 409 with the reason. Resuming many mailboxes at once skips that one (it is listed in skipped with the reason) and resumes the rest.

POST /mailboxes/:id/resume-warmup continues a paused ramp where it stopped and returns dayIndex and resumedMidRamp (false only for a mailbox paused before 26 Sep 2026, which restarts at day 0). PATCH /mailboxes/:id/warmup takes the same fields as start-warmup, all optional, and keeps the ramp’s current day.

Mailbox problems

GET /mailboxes/issues returns mailboxes (how many have a problem) and issues, one per problem: { mailboxId, email, kind, since, detail, fix }. detail is the error from the mail server, when there is one. fix says what to do.

A mailbox you paused yourself reports no problem.

Domains

Analytics

GET /analytics/overview returns totalSent, leadsContacted, totalOpened, totalClicked, totalReplied, totalPositive, totalBounced, totalLeads, totalMailboxes, and openRate, clickRate, replyRate, positiveRate, bounceRate.

• totalSent and totalBounced are emails; bounceRate is over totalSent.
• totalOpened, totalClicked, totalReplied and totalPositive are leads, each counted once; their rates are over leadsContacted.
• opensTracked / clicksTracked are false when no campaign in the workspace tracks opens or clicks. Those numbers then mean nothing.

These are the same rules as campaign stats.

Per mailbox and per domain

The period: from and to (an ISO date or date-time; to is not included, and a bare date is midnight UTC), or days back from now. Default: the last 30 days. At most 366 days.

GET /analytics/mailbox-stats returns { from, to, mailboxes }. Each mailbox has emailAddress, domain, healthStatus, sendingEnabled, dailySendCap, and for the period:

• sent, bouncedHard, bouncedSoft, bounced: emails. bounceRate is bounced over sent.
• failed: emails the receiving server refused at send time without it counting as a bounce (they are retried).
• leadsContacted, replied, positive (and opened, clicked): leads, each once. replyRate and positiveRate are over leadsContacted.
• lastSentAt.

And over the last 7 days, whatever the period:

sentLast7Days is the count behind it. Warmup mail is not counted anywhere here.

GET /analytics/domain-stats returns { from, to, domains }: the same numbers per sending domain, with mailboxes, spfStatus, dkimStatus, dmarcStatus. A domain’s activity is the best of its mailboxes’.

GET /analytics/bounces returns { from, to, bounces, total, page, limit }, newest first. Each has kind (hard or soft; with kind=failed, emails refused at send time), at, code (the SMTP code or enhanced status, e.g. 550 or 5.1.1), reason (the server’s message), leadEmail, mailboxEmail, domain, campaign and stepOrder (0 is the first step). Without kind, hard and soft bounces are listed. code and reason are null on bounces from before 2 Oct 2026.

Inbox placement tests