Skip to main content
PATCH
/
b2b
/
notification-settings
/
{settingId}
curl --request PATCH \
  --url https://{host}/b2b/notification-settings/{settingId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '{
  "active": true
}'
{
  "app": [
    {
      "category": "Activity",
      "notifications": [
        {
          "id": "app_transactional",
          "name": "Transaction Notifications",
          "description": "Receive notifications about deposits, withdrawals, and order settlements",
          "active": true
        }
      ]
    },
    {
      "category": "Market Insights",
      "notifications": [
        {
          "id": "app_learning_guide",
          "name": "Learning Guides",
          "description": "Get notified when new educational content is published",
          "active": true
        },
        {
          "id": "app_analyst_insight",
          "name": "Analyst Insights",
          "description": "Receive insights from our investment analysts",
          "active": false
        },
        {
          "id": "app_quick_take",
          "name": "Quick Takes",
          "description": "Get brief market updates and quick insights",
          "active": true
        },
        {
          "id": "app_daily_recap",
          "name": "Daily Market Recap",
          "description": "Daily summary of market movements and your portfolio",
          "active": true
        },
        {
          "id": "app_weekly_review",
          "name": "Weekly Review",
          "description": "Weekly summary of your portfolio performance",
          "active": false
        }
      ]
    },
    {
      "category": "Promotional",
      "notifications": [
        {
          "id": "app_promotional",
          "name": "Promotional Notifications",
          "description": "Receive updates about new features and special offers",
          "active": false
        }
      ]
    }
  ],
  "email": [
    {
      "category": "Activity",
      "notifications": [
        {
          "id": "email_transactional",
          "name": "Transaction Emails",
          "description": "Receive email notifications about account activity",
          "active": true
        }
      ]
    },
    {
      "category": "Newsletters",
      "notifications": [
        {
          "id": "email_wealthybites",
          "name": "WealthyBites Newsletter",
          "description": "Weekly newsletter with investment insights and market updates",
          "active": true
        }
      ]
    },
    {
      "category": "Promotional",
      "notifications": [
        {
          "id": "email_promotional",
          "name": "Promotional Emails",
          "description": "Receive emails about new features and special offers",
          "active": false
        }
      ]
    }
  ]
}

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.

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.

​
app
object[]

Array of app notification categories

​
email
object[]

Array of email notification categories