Skip to contentSkip to navigation

Pause Account Sending

Stop campaign email from one account without disconnecting it.

POST /api/v1/email-accounts/{account_id}/pause

Requires an API key with the write scope.

Stops campaign email from this account. Sends already queued on it are released and go out from the campaign's other accounts on the next scheduling pass; a follow-up whose own account is paused goes out from another account in the campaign. Replies keep arriving in the inbox, you can still reply by hand from the account, and warmup carries on. Pausing an account that is already paused changes nothing. Each pause is recorded in the Audit Log with who paused it and the reason. Resume with Resume Account Sending.

Path Parameters

account_id string path required

The unique identifier of the email account.

Body

reason string body

Optional note on why sending is paused, up to 200 characters. Shown in the audit log.

Response

data object

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

data
id string
Email account identifier.
email string
Mailbox address.
displayName string
Friendly name shown on sent mail, or null.
provider string
Provider the account was connected as.
smtpHost string
SMTP host.
smtpPort integer
SMTP port.
imapHost string
IMAP host.
imapPort integer
IMAP port.
timezone string
IANA timezone used for the account's daily limit window.
dailyLimit integer
Maximum campaign emails per day.
sentToday integer
Campaign emails sent today in the account's timezone. Warmup sends are not counted.
warmupEnabled boolean
Whether warmup is on.
warmupDailyLimit integer
Warmup mail per day once the ramp is complete.
warmupRampUpDays integer
Days the warmup ramp takes.
warmupStartDate string
ISO 8601 timestamp the ramp started, or null.
healthScore integer
Stored health score, or null. For the live placement score use Get Account Health.
domainAuth object
SPF, DKIM and DMARC check result, or null until checked.
domainAuthCheckedAt string
ISO 8601 timestamp of the last domain check, or null.
bounceRate number
Bounce rate.
replyRate number
Reply rate.
isActive boolean
Whether the account is used for sending.
connectionStatus string
Connection state, for example connected.
lastError string
Last connection error, or null.
sendingPausedAt string
ISO 8601 timestamp campaign sending was paused, or null while the account sends.
sendingPausedReason string
The reason given when pausing, or null.
createdAt string
ISO 8601 timestamp.
updatedAt string
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
422reason is longer than 200 characters

Rate Limit

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • 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?