Frequency Cap

Get frequency cap

Changed on

Returns the company frequency cap, or null when none is set. Only sequences with frequencyCapEnabled respect it; their email steps are skipped for a contact already at the cap. Campaigns count toward the cap but always send. Transactional emails never count. Requires the account:read scope.

get/frequency-cap

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/frequency-cap
  • Auth
    HTTP bearer

Response

Frequency cap returned

successboolean

Example response

{
  "frequencyCap": {
    "maxEmails": 1,
    "windowHours": 16
  }
}

Changes