User Preferences

User Alert Preferences allow individual customers to manage their personal alert settings. They enable users to opt in or out of specific alert types, choose notification channels, and scope alerts to specific accounts or locations, with institution‑level preferences serving as defaults when user preferences are not explicitly set.

End-user benefits

• Set personalized thresholds (for example balance alerts).
• Choose notification channels and manage alerts for specific accounts or cards.

Integration capabilities

• Provides personalized alert management for individual users.
• Supports multi‑channel delivery (Email, SMS, Push, Web) with user‑specific opt‑in/out controls.
• Enables flexible filtering by account, user, and alert type.
• Business Banking: use institutionCustomerId for location/business context; resolve the business entity via the Institution User API when needed.
• With client_credentials, pass hostUserId or loginId (mutually exclusive). Optional institutionCustomerId header for business context.

Scopes

Scope	Description
alertPref:read	Read alert preferences
alertPref:write	Write alert preferences

Required headers

Header	Description
Authorization	Bearer OAuth 2.0 access token
transactionId	UUID for request tracing

Error codes

Alert preference (PRMAPS_*)

Code	Message	HTTP Status Code
PRMAPS_10007	Invalid alert preference ID	404
PRMAPS_10008	Alert preference mismatch	400

Validation (PRMVAL_*)

Code	Message	HTTP Status Code
PRMVAL_10004	Invalid user	400
PRMVAL_10006	Invalid alert type	400
PRMVAL_10009	Requested alert type was not found for the FI	400
PRMVAL_10010	Preference not found for enrollmentId	400
PRMVAL_10011	Preference not found for institution	400
PRMVAL_10012	Value should not be null	400
PRMVAL_10013	Invalid alert preference	400
PRMVAL_10015	Alert type not configured for channel or disabled for Institution	400
PRMVAL_10016	Unsupported account type	400

Endpoints

Create User Alert Preference

Create a new alert preference for a user. This allows customers to opt-in to specific alert types and configure their notification preferences.

Delete User Alert Preference

Removal of particular user alert preference

Get Alert Preference by ID

Get Alert Preference by ID

List User Alert Preferences

Retrieve all alert preferences configured for a user. If user-specific preferences are not found, institution-level defaults are returned.

Update User Alert Preference

Update user alert preference for opt in/opt out