MailerGetSendWindows¶

GET mailer/sendWindows/list

Returns the send windows of the brand. The * row is the fallback for destinations without their own rule; the rest are country-specific.

Access Control¶

Allowed roles: admin, leader.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/sendWindows/list?limit=100&orderBy=%5B%22countryIso%22%2C%22ASC%22%5D
Authorization: <JWT_TOKEN>

{
  "command": "MailerGetSendWindows",
  "extID": "1",
  "data": {
    "limit": 100,
    "orderBy": [
      "countryIso",
      "ASC"
    ]
  }
}

const res = await platform.MailerGetSendWindows({
  limit: 100,
  orderBy: [
    "countryIso",
    "ASC"
  ]
});

Request Data¶

Field	Type	Required	Description
`limit`	int	No	Page size, `1..1000`, default `100`
`offset`	int	No	Rows to skip
`orderBy`	array	No	Sorting, for example `["id", "DESC"]`
`count`	array	No	Row count aggregate, `["id"]`
`where`	object	No	Filters, see Table filter syntax

Response Data¶

{
  "rows": [
    {
      "id": 5,
      "brand": "default",
      "countryIso": "DE",
      "timezone": null,
      "allowedFrom": "09:00",
      "allowedTo": "19:00",
      "weekdays": [1, 2, 3, 4, 5],
      "deferOutsideWindow": true,
      "status": "ENABLED"
    }
  ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Session may not read send windows