Frequency Cap

Set frequency cap

Changed on

Sets or replaces the company frequency cap. It applies from the next email step onward in sequences with frequencyCapEnabled. Requires the companies:manage scope plus owner or admin access.

put/frequency-cap

Request

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

Request body

maxEmailsinteger required

Most marketing emails one contact may receive in the window.

windowHoursinteger required

Rolling window in hours.

Example request

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

Response

Frequency cap saved

successboolean

Example response

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

Changes