Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Frequency Caps API

Define rolling-window limits on how often a single contact can be messaged. Enforcement happens inside messages.service.sendMessage against Redis sorted sets — sends that would exceed the cap return a FREQUENCY_CAP_EXCEEDED error and don’t dispatch. Base path: /v1/frequency-caps Authentication: API key (X-API-Key) or session JWT.
MethodPathPurpose
GET/v1/frequency-caps/List rules
POST/v1/frequency-caps/Create a rule
GET/v1/frequency-caps/{id}Get a rule
PATCH/v1/frequency-caps/{id}Update a rule
DELETE/v1/frequency-caps/{id}Delete a rule

​
Example — cap marketing SMS at 3 per day per contact

curl -X POST https://orbit-api.devotel.io/api/v1/frequency-caps/ \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing SMS daily cap",
    "channel": "sms",
    "category": "marketing",
    "limit": 3,
    "window_seconds": 86400
  }'
Transactional messages (OTPs, receipts) typically bypass caps via the category: "transactional" tag on the send request.

​
See also