Skip to main content
PATCH
Update Notification Preference

Authorizations

Authorization
string
header
required

A floo_ API key.

Headers

X-Floo-Org-Id
string<uuid>

Organization to act in; defaults to the one joined most recently.

Body

application/json

Select a notification category and its desired enabled state.

category
enum<string>
required

A user-muteable class of transactional email.

Membership in this enum is the muteable contract: an email type mapped to one of these consults the recipient's preference before sending; any email type not mapped here is always-send (transactional / security / destructive) and can never be muted. The muteable set is pinned by tests/test_notification_preferences.py so a security or destructive email can never be made silenceable by accident.

Available options:
deploy_success,
deploy_failure,
domains,
managed_services,
billing
enabled
boolean
required

Response

Successful Response

Wrap the caller's notification preferences by category.

preferences
NotificationPreference · object[]
required