Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Auth0-issued access token that includes the scopes listed for the endpoint.

Headers

x-user-id
string
required

MongoDB identifier of the user whose notification settings are being accessed or modified.

Pattern: ^[a-f0-9]{24}$
Example:

"507f1f77bcf86cd799439011"

Path Parameters

settingId
enum<string>
required

Identifier of the notification setting to update. Must be one of the valid notification setting IDs.

Available options:
app_transactional,
app_learning_guide,
app_analyst_insight,
app_quick_take,
app_weekly_review,
app_daily_recap,
app_promotional,
email_transactional,
email_promotional,
email_wealthybites
Example:

"app_transactional"

Body

application/json
active
boolean
required

New active status for the notification setting

Example:

true

Response

Notification setting updated successfully. Returns complete notification settings object.

Complete notification settings for a user, organized by notification type (app/email) and category. Both app and email are optional in the schema for flexibility, but in practice they will always be present since notification settings are created during user creation. Category names, notification names, and descriptions are localised based on the user's language preference.

app
object[]

Array of app notification categories

email
object[]

Array of email notification categories