Skip to main content
POST
/
mailchecks
Create New Mail Checks
curl --request POST \
  --url https://test.onlinecheckwriter.com/api/v3/mailchecks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isShippingToCustomAddress": true,
  "customFromAddressId": "address123",
  "customToAddressId": "address456",
  "customShippingTypeId": "shipping789",
  "mailChecks": [
    {
      "checkId": "bL3YGddEnmG1X7w",
      "shippingTypeId": 3,
      "paperTypeId": 7,
      "informTypeId": 10,
      "enableSmsInform": false,
      "enableEmailInform": true,
      "payeeEmail": "[email protected]",
      "payeePhone": "123456789"
    }
  ]
}
'
{
  "success": true,
  "message": "successfully mailed"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Payload to specify the mail checks and their attributes.

​
mailChecks
object[]
required

An array of mail check attributes.

​
isShippingToCustomAddress
boolean

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

Example:

false

​
customFromAddressId
string

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

Example:

"uJ7hGddEnmG1X7e"

​
customToAddressId
string

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

Example:

"dfGYGddEnmG1X7r"

​
customShippingTypeId
string

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

Example:

"1"

Response

successfully mailed

​
success
boolean
Example:

true

​
message
string
Example:

"successfully mailed"