REST API · projects

PUT /projects/{slug}/notifications/preferences

Set the token user's notification choices for one project. Merge semantics: only the types in the body change. Body: `{"preferences": {"<type key>": true|false, …}}`. A type the user's role may not receive on the project, or one not in the catalog, is rejected with 400 and nothing is saved. Account management token + `config`, or the companion app's sign-in + `notifications`.

The error-rate notice (`traffic.error_rate`) also carries its level, as two top-level body fields: `error_rate_percent` (whole number 1-100, default 5) and `error_rate_window_minutes` (5, 15 or 60, default 15). The GET returns both on that entry, and `channels` on every entry — what the notice is delivered on now. A value out of range is a 422.

put_api_project_notification_prefs_save

Authentication

  • Bearer

Parameters

NameInRequiredSchemaDescription
slug path yes {"type":"string","pattern":"[a-z0-9-]+"}

Responses

default

← REST API reference