GET /v1/alerts/settings
The account’s alert settings: timezone, the hour of the daily summary, weekdays-only, one delivery mode per kind, the default kinds and level of an unedited follow per follow type, the channel switches, whether the plan allows custom amounts, the sentence to show for each level, the bounds of a custom amount and the allowance meter. An account that never saved anything gets the defaults. Session only. 404 `alert_settings_disabled` while ALERT_SETTINGS_ENABLED is off.
The account’s alert settings: timezone, the hour of the daily summary, weekdays-only, one delivery mode per kind, the default kinds and level of an unedited follow per follow type, the channel switches, whether the plan allows custom amounts, the sentence to show for each level, the bounds of a custom amount and the allowance meter. An account that never saved anything gets the defaults. Session only. 404 alert_settings_disabled while ALERT_SETTINGS_ENABLED is off.
API key: Authorization: Bearer pk_live_… (mint at polyrank.app/api-keys)
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/alerts/settings"{ "timezone": "string", "summary_hour": 0, "weekdays_only": true, "delivery": { "trader_fill": "instant", "trader_board": "instant", "event_resolved": "instant", "event_added": "instant", "event_price_move": "instant", "event_notable_wallet": "instant" }, "defaults": { "trader": { "kinds": [ "trader_fill" ], "level": "quiet" }, "event": { "kinds": [ "trader_fill" ], "level": "quiet" } }, "channels": { "in_app": true, "email": true, "browser_push": true }, "can_custom": true, "levels": { "trader_fill": { "quiet": "string", "balanced": "string", "everything": "string" }, "event_price_move": { "quiet": "string", "balanced": "string", "everything": "string" }, "event_notable_wallet": { "quiet": "string", "balanced": "string", "everything": "string" } }, "custom_bounds": { "trader": { "min_trade_usd": [ -9007199254740991, -9007199254740991 ] }, "event": { "min_trade_usd": [ -9007199254740991, -9007199254740991 ], "price_move_points": [ -9007199254740991, -9007199254740991 ] } }, "timezone_set": true, "allowance": { "plan": "string", "day": { "used": -9007199254740991, "limit": -9007199254740991, "resets_at": "string" }, "month": { "used": -9007199254740991, "limit": -9007199254740991, "resets_at": "string" }, "over": true, "upgrade": true }}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}