curl --request PATCH \
--url https://{appid}.api-{region}.cometchat.io/v3/notifications/v1/preferences \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"groupPreferences": {
"groupMessages": 1,
"groupReplies": 1,
"groupReactions": 1,
"groupMemberLeft": 1,
"groupMemberAdded": 1,
"groupMemberJoined": 1,
"groupMemberKicked": 1,
"groupMemberBanned": 1,
"groupMemberUnbanned": 1,
"groupMemberScopeChanged": 1
},
"oneOnOnePreferences": {
"oneOnOneMessages": 1,
"oneOnOneReplies": 1,
"oneOnOneReactions": 1
},
"mutePreferences": {
"dnd": 1,
"schedule": {
"monday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"tuesday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"wednesday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"thursday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"friday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"saturday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"sunday": {
"from": 1179,
"to": 1179,
"dnd": true
}
}
},
"usePrivacyTemplate": true
}'
{
"data": {
"preferences": {
"group": {
"messagesSetting": 2,
"messagesOverride": true,
"repliesSetting": 2,
"repliesOverride": true,
"reactionsSetting": 2,
"reactionsOverride": true,
"memberLeftSetting": 1,
"memberLeftOverride": true,
"memberAddedSetting": 1,
"memberAddedOverride": true,
"memberJoinedSetting": 1,
"memberJoinedOverride": true,
"memberKickedSetting": 1,
"memberKickedOverride": true,
"memberBannedSetting": 1,
"memberBannedOverride": true,
"memberUnbannedSetting": 1,
"memberUnbannedOverride": true,
"memberScopeChangedSetting": 1,
"memberScopeChangedOverride": true
},
"oneOnOne": {
"messagesSetting": 2,
"messagesOverride": true,
"repliesSetting": 2,
"repliesOverride": true,
"reactionsSetting": 2,
"reactionsOverride": true
},
"mute": {
"dndPreferenceSetting": 1,
"dndPreferenceOverride": true,
"schedulePreferenceSetting": {
"monday": {
"from": 0,
"to": 2359,
"dnd": false
},
"tuesday": {
"from": 0,
"to": 2359,
"dnd": false
},
"wednesday": {
"from": 0,
"to": 2359,
"dnd": false
},
"thursday": {
"from": 0,
"to": 2359,
"dnd": false
},
"friday": {
"from": 0,
"to": 2359,
"dnd": false
},
"saturday": {
"from": 0,
"to": 2359,
"dnd": false
},
"sunday": {
"from": 0,
"to": 2359,
"dnd": false
}
},
"schedulePreferenceOverride": true,
"mutedGroupsOverride": true,
"mutedOneOnOnesOverride": true
}
},
"sound": {
"chat": "default",
"call": "default"
},
"templates": {
"usePrivacyTemplate": 3,
"textMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{message.data.text}}"
},
"textMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
},
"mediaMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body_audio": "Has sent an {{message.type}}",
"body_file": "Has sent a {{message.type}}",
"body_image": "Has sent an {{message.type}}",
"body_video": "Has sent a {{message.type}}"
},
"mediaMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body_audio": "New message",
"body_file": "New message",
"body_image": "New message",
"body_video": "New message"
},
"customMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{message.data.text}}",
"body_fallback": "New message"
},
"customMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{message.data.text}}",
"body_fallback": "New message"
},
"interactiveFormTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{data.interactiveData.title}}"
},
"interactiveFormTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
},
"interactiveCardTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{data.interactiveData.text}}"
},
"interactiveCardTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}}",
"body": "New message"
},
"interactiveSchedulerTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New invite"
},
"interactiveSchedulerTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New invite"
},
"interactiveCustomTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
},
"interactiveCustomTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
}
}
}
}
Update the preference for the given user.
curl --request PATCH \
--url https://{appid}.api-{region}.cometchat.io/v3/notifications/v1/preferences \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"groupPreferences": {
"groupMessages": 1,
"groupReplies": 1,
"groupReactions": 1,
"groupMemberLeft": 1,
"groupMemberAdded": 1,
"groupMemberJoined": 1,
"groupMemberKicked": 1,
"groupMemberBanned": 1,
"groupMemberUnbanned": 1,
"groupMemberScopeChanged": 1
},
"oneOnOnePreferences": {
"oneOnOneMessages": 1,
"oneOnOneReplies": 1,
"oneOnOneReactions": 1
},
"mutePreferences": {
"dnd": 1,
"schedule": {
"monday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"tuesday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"wednesday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"thursday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"friday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"saturday": {
"from": 1179,
"to": 1179,
"dnd": true
},
"sunday": {
"from": 1179,
"to": 1179,
"dnd": true
}
}
},
"usePrivacyTemplate": true
}'
{
"data": {
"preferences": {
"group": {
"messagesSetting": 2,
"messagesOverride": true,
"repliesSetting": 2,
"repliesOverride": true,
"reactionsSetting": 2,
"reactionsOverride": true,
"memberLeftSetting": 1,
"memberLeftOverride": true,
"memberAddedSetting": 1,
"memberAddedOverride": true,
"memberJoinedSetting": 1,
"memberJoinedOverride": true,
"memberKickedSetting": 1,
"memberKickedOverride": true,
"memberBannedSetting": 1,
"memberBannedOverride": true,
"memberUnbannedSetting": 1,
"memberUnbannedOverride": true,
"memberScopeChangedSetting": 1,
"memberScopeChangedOverride": true
},
"oneOnOne": {
"messagesSetting": 2,
"messagesOverride": true,
"repliesSetting": 2,
"repliesOverride": true,
"reactionsSetting": 2,
"reactionsOverride": true
},
"mute": {
"dndPreferenceSetting": 1,
"dndPreferenceOverride": true,
"schedulePreferenceSetting": {
"monday": {
"from": 0,
"to": 2359,
"dnd": false
},
"tuesday": {
"from": 0,
"to": 2359,
"dnd": false
},
"wednesday": {
"from": 0,
"to": 2359,
"dnd": false
},
"thursday": {
"from": 0,
"to": 2359,
"dnd": false
},
"friday": {
"from": 0,
"to": 2359,
"dnd": false
},
"saturday": {
"from": 0,
"to": 2359,
"dnd": false
},
"sunday": {
"from": 0,
"to": 2359,
"dnd": false
}
},
"schedulePreferenceOverride": true,
"mutedGroupsOverride": true,
"mutedOneOnOnesOverride": true
}
},
"sound": {
"chat": "default",
"call": "default"
},
"templates": {
"usePrivacyTemplate": 3,
"textMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{message.data.text}}"
},
"textMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
},
"mediaMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body_audio": "Has sent an {{message.type}}",
"body_file": "Has sent a {{message.type}}",
"body_image": "Has sent an {{message.type}}",
"body_video": "Has sent a {{message.type}}"
},
"mediaMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body_audio": "New message",
"body_file": "New message",
"body_image": "New message",
"body_video": "New message"
},
"customMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{message.data.text}}",
"body_fallback": "New message"
},
"customMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{message.data.text}}",
"body_fallback": "New message"
},
"interactiveFormTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{data.interactiveData.title}}"
},
"interactiveFormTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
},
"interactiveCardTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "{{data.interactiveData.text}}"
},
"interactiveCardTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}}",
"body": "New message"
},
"interactiveSchedulerTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New invite"
},
"interactiveSchedulerTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New invite"
},
"interactiveCustomTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
},
"interactiveCustomTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New message"
}
}
}
}
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
(Required) UID
Response data
A list of push notification's settings
The response is of type object
.
Was this page helpful?