PUT /v1/alerts/settings
Save a part of the alert settings; every key is optional and an absent key is kept. `delivery` is a partial map kind → instant | hourly | daily. `defaults.trader` and `defaults.event` each take `kinds` and/or `level`; a change applies at once to every follow that still has `uses_default: true` and to no follow that was edited. `channels` is a partial of the channel switches. Answers the whole object of GET. 400 `invalid_timezone` for a zone name the server does not know; 400 `invalid_kind` for a name that is not a kind, or a kind of the other follow type. Session only. 404 `alert_settings_disabled` while ALERT_SETTINGS_ENABLED is off.
Save a part of the alert settings; every key is optional and an absent key is kept. delivery is a partial map kind → instant | hourly | daily. defaults.trader and defaults.event each take kinds and/or level; a change applies at once to every follow that still has uses_default: true and to no follow that was edited. channels is a partial of the channel switches. Answers the whole object of GET. 400 invalid_timezone for a zone name the server does not know; 400 invalid_kind for a name that is not a kind, or a kind of the other follow type. 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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/alerts/settings" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}