Emails

Diagnose e-mail sending

Why the site's e-mail does not go out, or goes out slowly: the first call for "my broadcast is stuck", "nothing is sent", "sending is paused" or "why can't I start it". Five checks in the order sending is gated - the account, sending being enabled, the email balance, the plan, delivery - each with a stable reason code, what to do (next_action), who can do it (who) and facts in values. Read who before promising anything: what support decides is never promised. Name a broadcast or an automation to learn what holds it and what to do after the fix (then); nothing resumes or turns on by itself.

The answer is the stored state and makes no change; the balance carries its updated_at. Recipients and credits a broadcast needs are get_broadcast_recipients, its sender address get_broadcast, domain verification list_email_domains. The meaning of every code and how to word it for the user: the guide emails.sending.

get/v1/sites/{site_id}/emails/diagnostics

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required

Query parameters

broadcast_idinteger

A broadcast id from list_broadcasts

automation_idinteger

An automation id from list_automations

Response

Successful Response

state'ok' | 'warning' | 'blocking' | 'unknown' required

ok: nothing holds it. warning: it works, with a limit or a risk the user should know about. blocking: it does not send until the cause is fixed. unknown: the source could not be read now; ask again later.

Changes

No recorded changes to this operation across all 1 revision of this API.