Email domains

List sending domains

The sending domains of the site, the domains its emails go out from: for each, whether it is verified, where verification stands, the exact DNS records it needs, when they were last checked and what the user does next. Call it for questions about the sender: before the first broadcast from the user's own domain, when the "from" address looks wrong, when emails land in spam, or when verification seems stuck. An empty list is itself the answer: the site has no domain of its own and emails go out from the default Getsitecontrol sender.

next_action and next_action_hint of the list say what to do for the site as a whole; each domain carries its own. Domains are added in the Getsitecontrol admin; verify_email_domain checks one now. The list describes the setup only, nothing about individual emails, bounces or statistics. Every domain comes in one response.

get/v1/sites/{site_id}/email-domains

Request

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

Path parameters

site_idinteger required

Response

Successful Response

next_cursorstring nullable

Always null: every domain comes in one page

is_verifiedboolean required

true: at least one of the domains is verified

next_action'nothing' | 'add_domain' | 'start_verification' | 'publish_dns' | 'request_recheck' required

What the user does next. nothing: the domain is verified. add_domain: the site has no sending domain yet. start_verification: the domain has no records yet, verifying it gives them. publish_dns: add the records of required_dns at the domain's DNS provider; they are checked automatically after verification starts, verify again only to check now. request_recheck: checks stopped (two weeks passed, or the provider found a record missing or wrong); check the records and verify again.

next_action_hintstring required

One sentence on the next step, ready to show the user

Changes

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