Update a special notification

Update a Special Notification

The PUT /netevia/support/notifications endpoint allows support administrators to update an existing special notification in the Netevia banking application. By supplying the notification ID along with the updated fields, you can modify a notification's subject, body, audience roles, group category, severity level, or scheduled publication time. This endpoint ensures that all active notifications reflect accurate and current information for the targeted user segments.

Endpoint

PUT /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 previously created special notification needs to be corrected or refreshed — for example, to update the body text of a scheduled maintenance alert, change the target audience roles, or reschedule the publication time. This is also appropriate when a notification's severity level needs to be escalated from Info to Warning due to a developing situation. Any support workflow that manages broadcast communications to banking application users should route notification edits through this endpoint.

Request Body

FieldTypeRequiredDescription
idinteger (int32)YesUnique identifier of the notification to update
subjectstringNoSubject/title of the notification (max 1000 characters)
bodystringNoMain content/body text of the notification
groupstring (enum)NoNotification category. One of: Notifications, Messages, Campaigns, CardholderAgreement
levelstring (enum)NoSeverity level of the notification. One of: Info, Warning
publicationTimestring (date-time)NoScheduled date and time when the notification becomes visible (ISO 8601)
htmlLinkstringNoOptional URL to an HTML resource associated with the notification (max 1000 characters)
rolesarray of string (enum)NoTarget audience roles. Each item one of: Consumer, MainUser, SubUser
userIdsarray of integer (int32)NoSpecific user IDs to target. When provided, the notification is sent to these users only
{
  "id": 1042,
  "subject": "Scheduled Maintenance — Updated Window",
  "body": "Our scheduled maintenance window has been updated to Sunday, June 14 from 2:00 AM to 4:00 AM ET. Some services may be temporarily unavailable during this time.",
  "group": "Notifications",
  "level": "Warning",
  "publicationTime": "2026-06-13T06:00:00Z",
  "htmlLink": "https://status.netevia.com/maintenance-june-2026",
  "roles": ["Consumer", "MainUser", "SubUser"],
  "userIds": null
}

Response

200 OK

FieldTypeDescription
idinteger (int32)Unique identifier of the notification
createdDatestring (date-time)Timestamp when the notification was originally created
updatedDatestring (date-time) or nullTimestamp of the most recent update
subjectstring or nullSubject/title of the notification
bodystring or nullMain content/body text of the notification
groupstring (enum)Notification category: Notifications, Messages, Campaigns, or CardholderAgreement
levelstring (enum)Severity level: Info or Warning
publicationTimestring (date-time)Scheduled publication date and time
htmlLinkstring or nullURL to an associated HTML resource
rolesarray of string or nullTarget audience roles
userIdsarray of integer or nullTargeted user IDs, if applicable
{
  "id": 1042,
  "createdDate": "2026-06-08T14:23:00Z",
  "updatedDate": "2026-06-09T09:15:42Z",
  "subject": "Scheduled Maintenance — Updated Window",
  "body": "Our scheduled maintenance window has been updated to Sunday, June 14 from 2:00 AM to 4:00 AM ET. Some services may be temporarily unavailable during this time.",
  "group": "Notifications",
  "level": "Warning",
  "publicationTime": "2026-06-13T06:00:00Z",
  "htmlLink": "https://status.netevia.com/maintenance-june-2026",
  "roles": ["Consumer", "MainUser", "SubUser"],
  "userIds": null
}

Error Codes

CodeWhen it happens
400Missing required fields, invalid enum value, or subject/htmlLink exceeds maximum length
401Token missing, expired, or invalid
403Caller does not have support administrator permissions
404No notification found matching the provided id
500Internal server error

Common Mistakes

  • Omitting the id field — the notification ID is required in the request body and is the only way the system identifies which record to update.
  • Supplying an invalid enum value for group or level (e.g., "WARN" instead of "Warning") — use exact casing as documented.
  • Setting publicationTime to a past date — notifications scheduled in the past may publish immediately or be rejected depending on platform configuration.
  • Exceeding the 1000-character limit on subject or htmlLink — the request will return a 400 error.
  • Sending userIds alongside roles without understanding precedence — when userIds is populated, targeting may narrow to those specific users regardless of the roles array.

Related Endpoints

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

Example

curl -X PUT https://api.banking.netevia.dev/netevia/support/notifications \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1042,
    "subject": "Scheduled Maintenance — Updated Window",
    "body": "Our scheduled maintenance window has been updated to Sunday, June 14 from 2:00 AM to 4:00 AM ET. Some services may be temporarily unavailable during this time.",
    "group": "Notifications",
    "level": "Warning",
    "publicationTime": "2026-06-13T06:00:00Z",
    "htmlLink": "https://status.netevia.com/maintenance-june-2026",
    "roles": ["Consumer", "MainUser", "SubUser"]
  }'
Body Params
int32
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