Updates notification preference for the logged-in user.
Updates notification preference for the logged-in user.
Request
URI
PUT
https://{api_host}/notification-service/api/notifications/userPreference
COPY
Query Parameters
integer
page
Optional
Constraints:
default: 1
Page Number
integer
limit
Optional
Constraints:
default: 20
Number of entries per page
string
$orderby
Optional
Multiple comma-separated properties sorted in ascending or descending order
integer
$top
Optional
Sets the number of returned entries from the top of the response (total number per page in relation to skip)
integer
$skip
Optional
Sets how many entries you would like to skip
string
$filter
Optional
Boolean expression for whether a particular entry should be included in the response
Request Body
UserNotificationPreference
of type(s)
application/json
Required
Show optional properties
{
"notificationDeliveryMechanisms": [
{
"enabled": false,
"notificationProvider": {
"providerDirection": "string",
"type": "string"
}
}
]
}
{
"locale": "string",
"version": 0,
"notificationDeliveryMechanisms": [
{
"enabled": false,
"notificationProvider": {
"providerMode": {
"role": "string",
"overriddenGlobalProviderId": "string"
},
"name": "string",
"description": "string",
"providerDirection": "string",
"id": "string",
"type": "string",
"version": 0
}
}
]
}
string
locale
Optional
Constraints:
minLength: 0
maxLength: 20
locale
integer As int64
As int64
version
Optional
version
array of
object
notificationDeliveryMechanisms
Required
Constraints:
minItems: 1
maxItems: 2147483647
notificationDeliveryMechanisms
Responses
200
successful operation
Operation doesn't return any data structure
204
Operation doesn't return any data structure
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"notificationDeliveryMechanisms":["object"]}' https://{api_host}/notification-service/api/notifications/userPreference
On This Page
Notification Preference Operations
GET
Returns notification preference for the logged-in user.
PUT
Updates notification preference for the logged-in user.
GET
Returns A page Of default notification delivery mechanisms for the current tenant.
GET
Retrieves the supported notification locales.
GET
Returns A page Of notification delivery mechanisms for the logged-in user.