Update Email Account

Change an email account's settings, including warmup.

PATCHhttps://api.foxreach.io/api/v1/email-accounts/{account_id}

Requires an API key with the write scope.

Send only the fields you want to change. Omitted fields are left as they are.

Path Parameters#

account_idstringpathrequired

The unique identifier of the email account.

Body Parameters#

displayNamestringbody

Friendly name shown on sent mail.

signaturestringbody

Email signature.

dailyLimitintegerbody

Campaign emails per day, 1 to 200. Gmail and Microsoft hosts are capped at 50.

warmupEnabledbooleanbody

true starts warmup the same way as Enable Warmup: the ramp starts now. Sending true while the account is already warming keeps its ramp. false stops warmup. Turning it on counts against the free plan's warmed-inbox cap.

warmupDailyLimitintegerbody

Warmup mail per day, 1 to 50.

warmupIdentifierstringbody

A label for this account's warmup mail: letters, numbers, spaces, hyphens and underscores, up to 64 characters, unique in the workspace. Send null to clear it.

warmupIdentifierInSubjectbooleanbody

Also put the identifier in the warmup subject line. Needs a warmup identifier to be set.

warmupInboxSegregationEnabledbooleanbody

Force post-scan inbox segregation of warmup mail on or off for this account. An explicit null defers to the platform default.

isActivebooleanbody

Whether the account is used for sending.

timezonestringbody

IANA timezone name.

dkimSelectorstringbody

DKIM selector for custom SMTP servers: letters, numbers, dots, hyphens and underscores, up to 63 characters. An empty string or null clears it. Changing it re-runs the domain check.

Response#

dataobject

The email account object. Passwords and OAuth tokens are never returned.

Show data

idstring

Email account identifier.

emailstring

Mailbox address.

displayNamestring

Friendly name shown on sent mail, or null.

providerstring

Provider the account was connected as.

smtpHoststring

SMTP host.

smtpPortinteger

SMTP port.

imapHoststring

IMAP host.

imapPortinteger

IMAP port.

timezonestring

IANA timezone used for the account's daily limit window.

dailyLimitinteger

Maximum campaign emails per day.

sentTodayinteger

Campaign emails sent today in the account's timezone. Warmup sends are not counted.

warmupEnabledboolean

Whether warmup is on.

warmupDailyLimitinteger

Warmup mail per day once the ramp is complete.

warmupRampUpDaysinteger

Days the warmup ramp takes.

warmupStartDatestring

ISO 8601 timestamp the ramp started, or null.

healthScoreinteger

Stored health score, or null. For the live placement score use Get Account Health.

domainAuthobject

SPF, DKIM and DMARC check result, or null until checked.

domainAuthCheckedAtstring

ISO 8601 timestamp of the last domain check, or null.

bounceRatenumber

Bounce rate.

replyRatenumber

Reply rate.

isActiveboolean

Whether the account is used for sending.

connectionStatusstring

Connection state, for example connected.

lastErrorstring

Last connection error, or null.

createdAtstring

ISO 8601 timestamp.

updatedAtstring

ISO 8601 timestamp.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`404`	Email account not found, or it belongs to another workspace
`403`	`upgrade_required` when turning warmup on would exceed the free plan's warmed-inbox cap. The body is `{"detail": {"code": "upgrade_required", "limit_type": "warmup_accounts", "message": "...", "limit": 2, "current": 2}}`. A missing scope returns the same status with a plain `detail` string
`409`	Another account in the workspace already uses that `warmupIdentifier`
`422`	Daily limit above the provider cap: mailboxes on Gmail and Microsoft SMTP hosts are capped at 50 campaign emails per day; `Set a warmup identifier before adding it to the subject line.`; or the body failed validation

Rate Limit#

100 requests per minute, per API key. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Request

curl -X PATCH "https://api.foxreach.io/api/v1/email-accounts/cea_abc123" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"dailyLimit": 40, "displayName": "John at Company"}'

from foxreach import FoxReach
from foxreach.types import EmailAccountUpdate

client = FoxReach(api_key="otr_your_key")
account = client.email_accounts.update(
    "cea_abc123",
    EmailAccountUpdate(daily_limit=40, display_name="John at Company"),
)

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const account = await client.emailAccounts.update("cea_abc123", {
  dailyLimit: 40,
  displayName: "John at Company",
});

Response

{
  "data": {
    "id": "cea_abc123",
    "email": "outreach@company.com",
    "displayName": "John at Company",
    "provider": "gmail",
    "smtpHost": "smtp.gmail.com",
    "smtpPort": 587,
    "imapHost": "imap.gmail.com",
    "imapPort": 993,
    "timezone": "UTC",
    "dailyLimit": 40,
    "sentToday": 0,
    "warmupEnabled": false,
    "warmupDailyLimit": 5,
    "warmupRampUpDays": 14,
    "warmupStartDate": null,
    "healthScore": null,
    "domainAuth": null,
    "domainAuthCheckedAt": null,
    "bounceRate": 0,
    "replyRate": 0,
    "isActive": true,
    "connectionStatus": "connected",
    "lastError": null,
    "createdAt": "2026-10-31T10:00:00",
    "updatedAt": "2026-10-31T10:00:00"
  }
}

Was this page helpful?

View as MarkdownLast updated November 2, 2026