Create a new special notification

Create a New Special Notification

The POST /netevia/support/notifications endpoint enables support administrators to create and send special notifications to users of the Netevia banking platform. Notifications can be targeted to specific user roles or individual user IDs, and can be categorized by group type and severity level. On success, the API returns the newly created notification record including its assigned ID and timestamps.

Endpoint

POST /netevia/support/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

Use this endpoint when a support or platform administrator needs to broadcast a targeted alert, message, campaign, or cardholder agreement update to selected users. It is appropriate for informational updates (e.g., scheduled maintenance notices) as well as warning-level alerts (e.g., fraud or compliance notifications). Notifications can be scoped to all consumers, main business users, sub-users, or limited to a specific list of user IDs.

Request Body

The request body accepts one of two schemas:

Option 1 — Create new notification (publicnotificationrequest)

FieldTypeRequiredDescription
publicationTimestring (date-time)NoScheduled publication time for the notification. If omitted, publishes immediately.
groupstring (enum)NoNotification category. One of: Notifications, Messages, Campaigns, CardholderAgreement.
levelstring (enum)NoSeverity level. One of: Info, Warning.
bodystringNoFull message body/content of the notification.
subjectstringNoSubject line of the notification. Maximum 1000 characters.
rolesarray of string (enum)NoTarget audience by role. Each item one of: Consumer, MainUser, SubUser. If omitted, all roles may receive the notification.
userIdsarray of integerNoList of specific user IDs to target. Use to send notifications to individual users rather than roles.
htmlLinkstringNoOptional URL to an HTML page with additional notification content. Maximum 1000 characters.

Option 2 — Update existing notification (updatepublicnotificationrequest)

Inherits all fields from Option 1 above, plus:

FieldTypeRequiredDescription
idinteger (int32)YesThe ID of the existing notification to update.
{
  "publicationTime": "2026-06-10T09:00:00Z",
  "group": "Notifications",
  "level": "Warning",
  "subject": "Scheduled Maintenance Notice",
  "body": "The Netevia banking platform will undergo scheduled maintenance on June 10, 2026 from 2:00 AM to 4:00 AM UTC. Some services may be temporarily unavailable.",
  "roles": ["Consumer", "MainUser"],
  "userIds": null,
  "htmlLink": "https://status.netevia.com/maintenance-june-2026"
}

Response

200 OK

FieldTypeDescription
idinteger (int32)Unique identifier of the created or updated notification.
createdDatestring (date-time)Timestamp when the notification was created.
updatedDatestring (date-time)Timestamp of the last update to the notification. Null if never updated.
subjectstringSubject line of the notification.
bodystringFull message body/content of the notification.
groupstring (enum)Notification category. One of: Notifications, Messages, Campaigns, CardholderAgreement.
levelstring (enum)Severity level. One of: Info, Warning.
publicationTimestring (date-time)The scheduled or actual publication time of the notification.
htmlLinkstringURL to an HTML page with additional notification content.
rolesarray of string (enum)Target roles. Each item one of: Consumer, MainUser, SubUser.
userIdsarray of integerList of specific user IDs targeted by this notification.
{
  "id": 1042,
  "createdDate": "2026-06-09T15:32:00Z",
  "updatedDate": null,
  "subject": "Scheduled Maintenance Notice",
  "body": "The Netevia banking platform will undergo scheduled maintenance on June 10, 2026 from 2:00 AM to 4:00 AM UTC. Some services may be temporarily unavailable.",
  "group": "Notifications",
  "level": "Warning",
  "publicationTime": "2026-06-10T09:00:00Z",
  "htmlLink": "https://status.netevia.com/maintenance-june-2026",
  "roles": ["Consumer", "MainUser"],
  "userIds": null
}

Error Codes

CodeWhen it happens
400Missing required fields or validation error (e.g., subject exceeds 1000 characters, invalid enum value for group or level)
401Token missing, expired, or invalid
403Insufficient permissions to create or update notifications
404Notification not found (when using update schema with a non-existent id)
500Internal server error

Common Mistakes

  • Providing an invalid enum value for group (must be exactly one of Notifications, Messages, Campaigns, CardholderAgreement) or level (must be Info or Warning).
  • Exceeding the 1000-character maximum length for subject or htmlLink.
  • Using the update schema (including id) when intending to create a new notification — omit id to create a new record.
  • Omitting both roles and userIds, which may result in the notification not being delivered to any recipients depending on platform configuration.
  • Sending a publicationTime in the past, which may cause the notification to be published immediately or be rejected.

Related Endpoints

  • GET /netevia/support/notifications — Retrieve a list of existing special notifications
  • GET /netevia/support/notifications/{id} — Retrieve a specific notification by ID
  • DELETE /netevia/support/notifications/{id} — Delete a specific notification

Example

curl -X POST https://api.banking.netevia.dev/netevia/support/notifications \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "publicationTime": "2026-06-10T09:00:00Z",
    "group": "Notifications",
    "level": "Warning",
    "subject": "Scheduled Maintenance Notice",
    "body": "The Netevia banking platform will undergo scheduled maintenance on June 10, 2026 from 2:00 AM to 4:00 AM UTC. Some services may be temporarily unavailable.",
    "roles": ["Consumer", "MainUser"],
    "htmlLink": "https://status.netevia.com/maintenance-june-2026"
  }'
Body Params
date-time | null
string
enum
Allowed:
string
enum
Allowed:
string | null
string | null
roles
array of objects | null
roles
Allowed:
userIds
array of int32s | null
userIds
string | null
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