Skip to main content

​
Error envelope

Failed requests return success: false with a message and HTTP status:
Validation errors (from a malformed body) include the field-level detail Nest’s validation pipe produces.

​
Common status codes

​
Validation rules

The API whitelists request bodies and rejects unknown properties. Send only the documented fields — an unexpected field returns 400.

​
Rate limits

Public endpoints inherit a default of 60 requests per minute per caller. Tighter limits where noted: A rate-limited request returns 429. Back off and retry with exponential delay.
Transactional sends return 202 Accepted — the message is queued and passes the same pipeline (suppression, consent for marketing, wallet for SMS) at the worker. A 202 means accepted for processing, not delivered.