Skip to main content
POST
Check your domain

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Response

Your sending identity, as it now is.

sender_kind
enum<string>
required

shared: RescueConsole's address. domain: your own domain. single_sender: one address of yours, confirmed by a link.

Available options:
shared,
domain,
single_sender
from_address
string
required

The From line these settings make. When from_name is empty, mail goes out under your organization's name, which this field does not show. Empty while your organization cannot send.

can_send
boolean
required

false means email from your organization is refused right now, for the reason in blocked_reason.

sender_domain
string | null

Your own domain, once claimed.

single_sender_email
string | null

Your one address, once claimed.

verification_status
enum<string> | null

Where verifying your own domain or address stands.

Available options:
none,
pending,
verified,
failed,
null
verification_detail
string | null

What to do next, or what the check found missing.

last_checked_at
string | null

When the domain or address was last checked.

from_name
string | null

The name mail is sent under. Null uses your organization's name.

from_local_part
string | null

The part before the @, on the shared address or your own domain. Null means noreply.

reply_to
string | null

Where replies go: your default inbox.

dns_records
object[] | null

The records to add at your domain's DNS host, for your own domain.

track_opens
boolean

Whether opens are reported.

track_clicks
boolean

Whether clicked links are reported.

tracking_domain
string | null
blocked_reason
enum<string> | null
Available options:
no_sender_configured,
domain_not_verified,
single_sender_not_verified,
null
is_provisioned
boolean

Whether email sending has been set up for your organization.

shared_address
string

Present only while sending has not been set up: the shared address your organization will send from.