Changing the notification preference of the authenticated user

Note

The notification preference is only available for an organisation with the anomalies feature enabled, and only for users who are neither a SOC administrator nor a SOC user. SOC administrators and SOC users add their email address to the notification recipient list of the relevant organisation instead.

Sends a PATCH request to the endpoint /users/me/notification-preferences.

Description

The Change-Notification-Preferences request allows you to change the mitigation and anomaly notification email preference of the authenticated user.

Requirements

Values of the request: none

Objects: NotificationPreferencesVO

Request

To change the notification preference, no additional information needs to be added to the path of the request.

For a detailed specification of which information is required to change the notification preference, define the object NotificationPreferencesVO with the following attributes in the body:

Attributes	Description	Values
notificationsEnabled	Indicates whether the user is opted in to mitigation and anomaly notification emails.	true, false

The system responds by returning the object ApiUser with the updated information.

The object provides the following information:

Attributes	Description	Values
id	The ID of the user.	string
name	The full name of the user.	string
email	The email address of the user.	string
notificationsEnabled	Indicates whether the user is opted in to mitigation and anomaly notification emails.	true, false
activeOrganisation	The organisation context the token operates in.	object

Example

Example request body:

{
  "notificationsEnabled": true
}

Responses

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.
422	The request was unsuccessful because the submitted data could not be processed.