Skip to content

MailerCheckSendWindow

GET mailer/sendWindow/check

Answers whether a recipient in a given country can be emailed right now, shows the local time it was judged by, and — when the window is closed — when it opens.

The CRM uses it to show "will be sent at 09:00 local time" instead of a bare refusal.

Access Control

Allowed roles: admin, leader, manager.

Request

GET request
GET https://{broker_domain}/mailer/sendWindow/check?countryIso=DE&[email protected]
Authorization: <JWT_TOKEN>
{
  "command": "MailerCheckSendWindow",
  "extID": "1",
  "data": {
    "countryIso": "DE",
    "email": "[email protected]"
  }
}
const res = await platform.MailerCheckSendWindow({
  countryIso: "DE",
  email: "[email protected]"
});

Request Data

Field Type Required Description
countryIso string No Recipient country from the CRM card; the * rule applies when unknown
email string No Recipient address, echoed back in the response for convenience

Response Data

Reasons: OUTSIDE_SENDING_HOURS, OUTSIDE_SENDING_DAYS, WINDOW_NOT_CONFIGURED, NO_WINDOW_CONFIGURED. The last two allow sending — they say the module had nothing to check.

{
  "email": "[email protected]",
  "countryIso": "DE",
  "windowId": 5,
  "allowed": false,
  "reason": "OUTSIDE_SENDING_HOURS",
  "timezone": "Europe/Berlin",
  "localTime": "22:14",
  "weekday": 1,
  "window": "09:00–19:00",
  "deferOutsideWindow": true,
  "opensAt": "2026-08-25T07:00:00.000Z"
}

Errors

Code Error Description
400 VALIDATION_ERROR Country code is out of range