POST
/
mailchecks

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
mailChecks
object[]
required

An array of mail check attributes.

isShippingToCustomAddress
boolean

Value is true if sending mail to custom address. Defaults to false.

customFromAddressId
string

Must be a custom 'from' address ID. Required if isShippingToCustomAddress is true.

customToAddressId
string

Must be a custom 'to' address ID. Required if isShippingToCustomAddress is true.

customShippingTypeId
string

Must be a valid custom shipping type ID. Required if isShippingToCustomAddress is true.

Response

200 - application/json
success
boolean
message
string