PATCH /v1/follows/{type}/{id}
Toggle the notify bell on a follow (owner only). For an event, :id is the stored target_id (the canonical slug) or any slug of the fixture. `notify` is required while alert settings are off. With alert settings on (ALERT_SETTINGS_ENABLED) the body takes `notify`, `alerts` or both (at least one): `alerts` is a partial of the follow’s own choice and `alerts: null` puts the follow back on the account default; the answer carries `uses_default` and `alerts`. The refusals are those of POST /v1/follows (`plan_required`, `invalid_custom`, `invalid_kind`), and a refused request writes nothing.
Toggle the notify bell on a follow (owner only). For an event, :id is the stored target_id (the canonical slug) or any slug of the fixture. notify is required while alert settings are off. With alert settings on (ALERT_SETTINGS_ENABLED) the body takes notify, alerts or both (at least one): alerts is a partial of the follow’s own choice and alerts: null puts the follow back on the account default; the answer carries uses_default and alerts. The refusals are those of POST /v1/follows (plan_required, invalid_custom, invalid_kind), and a refused request writes nothing.
API key: Authorization: Bearer pk_live_… (mint at polyrank.app/api-keys)
In: header
Path Parameters
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 PATCH "https://example.com/v1/follows/trader/string" \ -H "Content-Type: application/json" \ -d '{}'{ "target_type": "trader", "target_id": "string", "notify": true, "created_at": "string", "event": { "slug": "string", "title": "string", "image_url": "string", "questions": -9007199254740991, "open_questions": -9007199254740991, "status": "open" }, "uses_default": true, "alerts": { "kinds": [ "trader_fill" ], "level": "quiet", "custom": { "min_trade_usd": -9007199254740991, "price_move_points": -9007199254740991 } }}{ "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"}