Get Notification Preferences

Get Notification Preferences

Get UserPreferncies categories

Request
URI
GET
https://{api_host}/api/notification/loggedin/user/preferences/categories
COPY
Query Parameters
string
include
Optional

Denotes if the notification types should be included in the response.
* notification_types - include notification types in the response

string
category_name
Optional
  • Filter the response and returns only results for the specific category.
Possible values are : Service_Health, Resource_Health, SDDC_Maintenance, Operation, Elastic_DRS, VMware_Site_Recovery_Service, Org_General,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NotificationPreferencesResponse of type(s) application/json 
{
    "categories": [
        {
            "channels": {
                "channels": "string"
            },
            "display_name": "string",
            "name": "string",
            "notification_types": [
                {
                    "channels": {
                        "channels": "string"
                    },
                    "display_name": "string",
                    "name": "string",
                    "priority": "string"
                }
            ]
        }
    ]
}
array of object
categories
Optional

User notification category preference


401

Unauthorized

Returns NotificationPreferencesResponse of type(s) application/json 
"NotificationPreferencesResponse Object"
array of object
categories
Optional

User notification category preference


403

Forbidden

Returns NotificationPreferencesResponse of type(s) application/json 
"NotificationPreferencesResponse Object"
array of object
categories
Optional

User notification category preference


500

Internal Server Error

Returns ErrorResponse of type(s) application/json 
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/notification/loggedin/user/preferences/categories
On This Page
Notification Preferences Operations
GET
Get Notification Preferences
PATCH
Update Notification Preferences