Usage

Per-contact frequency cap

Requires authentication only (any valid API key).

get/settings/frequency-cap

Request

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

Response

Current frequency cap. With the cap on it includes impact: how many messages were dropped or deferred in the last 30 days, and how many contacts were affected.

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.