Setup Notification Settings

Configure email and push notification preferences for the authenticated user.

Setup Notification Settings

This endpoint allows partners to configure notification preferences for the authenticated user by enabling or disabling email and push notifications. Settings are applied immediately upon a successful request. Use this endpoint during onboarding or whenever a user updates their communication preferences.

Endpoint

POST /settings/informing

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

Use this endpoint when a user opts in or out of email or push notifications through your application's settings interface. This is also appropriate during account setup to establish initial notification preferences. Both notification channels can be toggled independently to match each user's communication preferences.

Request Body

FieldTypeRequiredDescription
emailEnabledbooleanNoFlag to enable or disable email notifications
pushEnabledbooleanNoFlag to enable or disable push notifications
{
  "emailEnabled": true,
  "pushEnabled": false
}

Response

200 OK

A successful request returns an HTTP 200 status with no response body, indicating notification settings were updated successfully.

Error Codes

CodeWhen it happens
400Missing required fields or validation error
401Token missing, expired, or invalid
403Insufficient permissions
404Resource not found
500Internal server error

Common Mistakes

  • Sending non-boolean values for emailEnabled or pushEnabled (e.g., strings "true" or "false" instead of true or false)
  • Omitting the Authorization header or using an expired token, which results in a 401 error
  • Sending an empty request body — include at least one of the two fields to update a preference

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an existing Bearer token

Example

curl -X POST https://api.banking.netevia.dev/settings/informing \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emailEnabled": true,
    "pushEnabled": false
  }'
Body Params

Request model for creating/updating notification settings

boolean

Flag enabled email notifications

boolean

Flag enabled push notifications

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