NotificationUnsubscribeMessageDto¶
Example Json Object
1{
2 "id": 0,
3 "targetId": "string",
4 "targetType": "string",
5 "topicApplication": "NFS",
6 "topicName": "string",
7 "topicPriority": "HIGH",
8 "topicEnCaption": "string",
9 "topicFrCaption": "string",
10 "username": "string",
11 "action": "SUBSCRIBE"
12}
📄 Description: Data transfer object representing a user’s request to unsubscribe from notifications, facilitating the management of user preferences and enhancing engagement strategies.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
targetId |
string |
true |
none |
Unique identifier for the target |
targetType |
string |
true |
none |
Type of the target |
topicApplication |
string |
true |
none |
Specifies the application topic for which the user wishes to unsubscribe from notifications. |
topicName |
string |
true |
none |
Name of the topic |
topicPriority |
string |
true |
none |
Priority of the topic |
topicEnCaption |
string |
false |
none |
Descriptive label for the topic in English associated with the notification unsubscribe message, facilitating clear communication with users. |
topicFrCaption |
string |
false |
none |
Caption for the topic in French, used to provide localized content for notifications related to user subscriptions. |
username |
string |
true |
none |
Unique identifier for the user opting to unsubscribe from notifications, ensuring accurate processing of subscription preferences. |
action |
string |
false |
none |
Specifies the type of action to be taken in relation to the notification unsubscribe request. |
Enumerated Values
Attribute |
Value |
|---|---|
action |
SUBSCRIBE, UNSUBSCRIBE |
topicApplication |
AP, FOS, NFS, SPB, SSB |
topicPriority |
HIGH, LOW, MEDIUM |