Usage

Set the frequency cap

At most max MARKETING messages per contact every days days. Needed because no flow knows about the others: someone who joins a list on Monday, clicks on Tuesday and has an event during the week gets four emails in three days without anyone having decided it. Transactional messages are never held and do not count. Out-of-range values are clamped into the limits instead of being rejected. Required scope: settings:write.

patch/settings/frequency-cap

Request

  • Base URL: https://sending.dev/api/v1
  • URL: https://sending.dev/api/v1/settings/frequency-cap
  • Auth: HTTP bearer

Request body

maxinteger nullable

Maximum marketing messages per contact in the window; null = no cap.

daysinteger

Window size in days (1-90).

policy'skip' | 'defer'

skip drops the excess message, defer postpones it until the window frees up.

Response

Cap updated.

maxinteger nullable required

Maximum marketing messages per contact in the window; null = no cap.

daysinteger required

Window size in days (1-90).

policy'skip' | 'defer' required

skip drops the excess message, defer postpones it until the window frees up.

Changes

No recorded changes to this operation across all 1 revision of this API.