Skip to main content
Use this endpoint to update the notification and platform preferences for your Shogun account. You can submit a partial update — only the sections included in the request body are modified, and everything else remains unchanged. Changes take effect immediately after a successful response.

Endpoint

POST /api/v1/notification/web/save_preferences

Authentication

All requests must include a valid Dashboard Bearer token in the Authorization header.
HeaderTypeRequiredDescription
AuthorizationstringYesBearer <token> — obtain from Login
Content-TypestringYesapplication/json

Request Body

All fields are optional — include only the sections you want to update.
balance_monitoring
object
Configure balance monitoring alerts for your account.
activity_emails
object
Toggle email notifications for specific transaction events. Each key is an event name and each value is a boolean.Common event keys:
  • inflow.received — credit received on an account
  • outflow.completed — debit completed successfully
  • transfer.failed — outbound transfer failed
system_updates
object
Toggle notifications for platform-level events. Common keys:
  • system.product_update — new feature announcements
  • system.maintenance — scheduled maintenance notices

Example Request Body

{
  "balance_monitoring": {
    "enabled": true,
    "threshold": "50000.00",
    "recipients": [
      "ops@yourcompany.com",
      "cfo@yourcompany.com"
    ]
  },
  "activity_emails": {
    "inflow.received": true,
    "outflow.completed": true,
    "transfer.failed": true
  },
  "system_updates": {
    "system.product_update": true,
    "system.maintenance": false
  }
}

Response

A successful response confirms your preferences have been saved.

Success

{
  "status": true,
  "response_code": "00",
  "message": "Preferences saved successfully"
}

Example

curl --request POST \
  --url https://baasapi.payrepmfb.com/api/v1/notification/web/save_preferences \
  --header 'Authorization: Bearer <your_dashboard_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "balance_monitoring": {
      "enabled": true,
      "threshold": "50000.00",
      "recipients": ["ops@yourcompany.com"]
    },
    "activity_emails": {
      "inflow.received": true,
      "transfer.failed": true
    }
  }'