Update the caller's notification preferences

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Request

This endpoint expects an object.

categoriesmap from strings to nullable booleansOptional

quiet_hours_enabledboolean or nullOptional

quiet_hours_startstring or nullOptional

quiet_hours_endstring or nullOptional

timezonestring or nullOptional

Sets a user-chosen zone, or the device's when sent with follow_device: true. "" clears it and hands the choice back to device reports, and is refused while quiet hours depend on it. null leaves it unchanged.

follow_deviceboolean or nullOptional

true stores timezone as the device's zone (timezone_source: device) rather than a user choice, so later registrations keep it current. Needs a non-empty timezone, and works while quiet hours are on. false or null is the same as leaving it out.

Response

The preferences after the update.

categoriesmap from strings to booleansOptional

Every category, keyed by NotificationCategory, with its effective setting — the user's choice, or the default.

quiet_hours_enabledbooleanOptional

quiet_hours_startstring or nullOptionalformat: "^[0-2][0-9]:[0-5][0-9]$"

Local time in timezone, 24-hour HH:MM.

quiet_hours_endstring or nullOptionalformat: "^[0-2][0-9]:[0-5][0-9]$"

Local time in timezone. Earlier than the start means the window wraps midnight.

timezonestringOptional

IANA zone quiet hours are evaluated in. Empty until a device reports one or the user chooses one.

timezone_sourceenumOptional

device — the latest zone a registered install reported. user — chosen explicitly; device reports never overwrite it. Empty when no zone is known.

Allowed values:

updated_atdatetime or nullOptional

available_categorieslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error