Developer portal
POST /public/unsubscribe
Unsubscribe an email address from monitor and GTM mailing flows.
PilotPOST /public/unsubscribePublic
Summary
Unsubscribe an email address from monitor and GTM mailing flows.
Example
curl
curl -X POST "https://sparkling-vibrancy-production-1a7a.up.railway.app/public/unsubscribe" \
-H "Authorization: Bearer 811f31d4-5b8e-4ed0-a7a2-8176e05eba63" \
-H "Content-Type: application/json" \
-d '{
"email": "security@acmebank.com",
"reason": "no-longer-relevant"
}'Errors
| Code | Meaning | Typical cause | Suggested fix |
|---|---|---|---|
| 404 | Not found | Scan, schedule, share link, or resource id does not exist or expired. | Verify id and tenant scope; share links expire per expiresHours. |
| 422 | Unprocessable entity | Invalid payload shape, unsupported scenario, or infeasible constraints. | Fix field errors in response detail; relax constraints and retry. |
| 429 | Too many requests | Per-key rate limit exceeded (default 300 requests per minute) or public endpoint limit. | Backoff with jitter; cache results; request higher limit for production. |
| 500 | Internal server error | Unexpected backend failure; includes requestId in response. | Retry with exponential backoff; contact support with requestId if persistent. |
See the full errors reference.
Found an issue? Report documentation feedback