Skip to content
Docs

Enable Warmup

Start warming up an email account.

POSThttps://api.foxreach.io/api/v1/email-accounts/{account_id}/warmup/enable

Requires an API key with the write scope.

Adds the account to the warmup pool and starts its ramp from day 0 now. There is no request body. Calling it on an account that is already warming restarts the ramp; to keep a running ramp, use Update Email Account with warmupEnabled: true.

Path Parameters#

account_idstringpathrequired

The unique identifier of the email account.

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#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: write
404Email account not found, or it belongs to another workspace
403upgrade_required when the free plan's warmed-inbox cap is reached. The body is {"detail": {"code": "upgrade_required", "limit_type": "warmup_accounts", "message": "...", "limit": 2, "current": 2}}. Paid plans are not capped

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.

Was this page helpful?
View as MarkdownLast updated November 2, 2026