Notification settings setup

Notification Settings Setup

Deprecated: This endpoint is marked deprecated. Use the current notification settings endpoint if available, or contact Netevia support for the recommended replacement.

This endpoint allows partners to configure notification preferences for the authenticated user, including enabling or disabling email and push notifications and registering the devices that should receive push alerts. The response mirrors the saved configuration, including the full list of registered devices and their metadata.

Endpoint

POST /settings/notifications

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Call this endpoint during onboarding or whenever a user changes their notification preferences in your application. Use it to register new mobile devices for push notifications or to toggle email and push channels on or off. Because the endpoint is deprecated, plan to migrate to the current notification settings endpoint when it becomes available.

Request Body

FieldTypeRequiredDescription
emailEnabledbooleanNoWhether email notifications are enabled for this user
pushEnabledbooleanNoWhether push notifications are enabled for this user
Devicesarray of device objectsNoList of devices to register for push notifications
Devices[].deviceIdstringYes (per device)Unique identifier for the device
Devices[].deviceNamestringYes (per device)Human-readable name for the device
{
  "emailEnabled": true,
  "pushEnabled": true,
  "Devices": [
    {
      "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "deviceName": "John's iPhone 15"
    },
    {
      "deviceId": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
      "deviceName": "John's iPad Pro"
    }
  ]
}

Response

200 OK

FieldTypeDescription
emailEnabledbooleanWhether email notifications are enabled
pushEnabledbooleanWhether push notifications are enabled
DevicesarrayList of registered devices with status metadata
Devices[].deviceIdstringUnique identifier of the registered device
Devices[].deviceNamestringHuman-readable name of the device
Devices[].creationDatestring (date-time)ISO 8601 timestamp when the device was registered
Devices[].isDeletedbooleanWhether the device has been removed from the account
Devices[].deletionDatestring (date-time) or nullISO 8601 timestamp of device deletion, if applicable
Devices[].isActivebooleanWhether the device is currently active for push delivery
{
  "emailEnabled": true,
  "pushEnabled": true,
  "Devices": [
    {
      "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "deviceName": "John's iPhone 15",
      "creationDate": "2026-01-15T10:30:00Z",
      "isDeleted": false,
      "deletionDate": null,
      "isActive": true
    },
    {
      "deviceId": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
      "deviceName": "John's iPad Pro",
      "creationDate": "2026-03-22T08:15:00Z",
      "isDeleted": false,
      "deletionDate": null,
      "isActive": true
    }
  ]
}

Error Codes

CodeWhen it happens
400Missing required fields or validation error (e.g., deviceId or deviceName absent in a device entry)
401Token missing, expired, or invalid
403Insufficient permissions
404Resource not found
500Internal server error

Common Mistakes

  • Omitting deviceId or deviceName inside a Devices entry — both fields are required when providing any device object, and requests will fail validation if either is missing or empty.
  • Sending a non-boolean value (e.g., the string "true") for emailEnabled or pushEnabled — the API strictly expects JSON boolean true or false.
  • Relying on this endpoint for new integrations — this endpoint is deprecated; verify with Netevia support whether a newer notification settings endpoint should be used instead.

Related Endpoints

  • GET /settings/notifications — Retrieve the current notification settings for the authenticated user
  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an expiring Bearer token

Example

curl -X POST https://api.banking.netevia.dev/settings/notifications \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emailEnabled": true,
    "pushEnabled": true,
    "Devices": [
      {
        "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "deviceName": "John'\''s iPhone 15"
      }
    ]
  }'
Body Params

Request model for creating/updating notification settings

boolean

Flag enabled email notifications

boolean

Flag enabled push notifications

Devices
array of objects | null

Array of devices information

Devices
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json