Skip to content

Get Safe To Send

GET
/deliverability/safe-to-send

One verdict: can I send right now, and if not, why not.

The cheapest thing to call before a launch. A false here with a live sequence running is the signal to pause rather than to push.

Authorizations

Parameters

Query Parameters

domain
Any of:
string
/^[A-Za-z0-9.\-]{1,253}$/

Limit the verdict to one domain. Omit for the whole fleet.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string