Sign in

v101

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-08235133843.7 KB
Sending Status

Get sending status

Returns whether company-level sending is active, paused, or suspended, the pause reason, the sender-health counts and thresholds behind it, the automated review state, whether sending can be restored without support, and ordered remediation steps. Call this whenever a send or test send fails for a reason that is not a validation error. Enforcement uses all-time totals from a reset watermark rather than a rolling window, so metricsWindow.expiresAt is always null and waiting does not restore sending. Requires the account:read scope.

get/sending-status

Response

Sending status returned

successboolean
status'active' | 'paused' | 'suspended'

Anything other than active blocks every send for this workspace, including test sends.

pauseReasonstring nullable

Enforcement message including the measured rate, the threshold it crossed, and the volume it was measured over.

pauseReasonKind'high_hard_bounce_rate' | 'high_soft_bounce_rate' | 'high_complaint_rate' | 'phishing_guard' | 'manual' | 'other' nullable

Only high_hard_bounce_rate can be cleared through the resume endpoint.

pausedAtstring date-time nullable

Example response

{
  "success": true,
  "pauseReason": "Bounce rate (9.910%) exceeded threshold (5%) for 111 total emails"
}