curl --request PATCH \
--url https://{appid}.api-{region}.cometchat.io/v3/notifications/v1/settings \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"preferences": {
"push": {
"includeMessageObjectSetting": true,
"includeSenderMetadataSetting": true,
"includeReceiverMetadataSetting": true,
"trimTextFieldSetting": true,
"includeMessageMetadataSetting": true,
"customJson": {}
},
"call": {
"initiatedSetting": 2,
"ongoingSetting": 2,
"cancelledSetting": 2,
"busySetting": 2,
"rejectedSetting": 2,
"unansweredSetting": 2,
"endedSetting": 2
},
"bypassPreferencesForMentions": true,
"group": {
"messagesSetting": 1,
"messagesOverride": true,
"repliesSetting": 1,
"repliesOverride": true,
"reactionsSetting": 1,
"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,
"messageEditedSetting": 1,
"messageDeletedSetting": 1
},
"oneOnOne": {
"messagesSetting": 1,
"messagesOverride": true,
"repliesSetting": 1,
"repliesOverride": true,
"reactionsSetting": 1,
"reactionsOverride": true,
"messageEditedSetting": 1,
"messageDeletedSetting": 1
},
"mute": {
"dndPreferenceOverride": true,
"mutedGroupsOverride": true,
"mutedOneOnOnesOverride": true,
"schedulePreferenceSetting": {
"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
}
},
"schedulePreferenceOverride": true
},
"email": {
"notifyForUnreadOnly": true,
"intervalInSeconds": 123,
"maxPerDay": 123,
"maxPerDayPerConversation": 123
},
"sms": {
"notifyForUnreadOnly": true,
"intervalInSeconds": 123,
"maxPerDay": 123,
"maxPerDayPerConversation": 123
}
},
"sound": {
"chat": "<string>",
"call": "<string>"
},
"templates": {
"usePrivacyTemplate": 1,
"textMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"textMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"mediaMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body_image": "Has sent an {{message.type}}",
"body_audio": "Has sent an {{message.type}}",
"body_video": "Has sent a {{message.type}}",
"body_file": "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_image": "Has sent an {{message.type}}",
"body_audio": "Has sent an {{message.type}}",
"body_video": "Has sent a {{message.type}}",
"body_file": "Has sent a {{message.type}}"
},
"customMessageTemplateDefault": {
"body_fallback": "<string>",
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"customMessageTemplatePrivacy": {
"body_fallback": "<string>",
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveFormTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveFormTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCardTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCardTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveSchedulerTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveSchedulerTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCustomTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCustomTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"emailSubjectTemplateDefault": {
"subjectGroup": "While you were away...",
"subjectOneOnOne": "While you were away..."
},
"emailSubjectTemplatePrivacy": {
"subjectGroup": "While you were away...",
"subjectOneOnOne": "While you were away..."
},
"smsContentTemplateDefault": {
"bodyGroup": "You'\''ve received new messages in {{groupDetails.name}}! You can read the message at https://your-website.com.",
"bodyOneOnOne": "You'\''ve received new messages from {{sender.name}}! You can read the message at https://your-website.com."
},
"smsContentTemplatePrivacy": {
"bodyGroup": "You'\''ve received new messages in {{groupDetails.name}}! You can read the message at https://your-website.com.",
"bodyOneOnOne": "You'\''ve received new messages from {{sender.name}}! You can read the message at https://your-website.com."
}
}
}'
{
"data": {
"success": true
}
}
Update preferences, templates and sounds for the given app.
curl --request PATCH \
--url https://{appid}.api-{region}.cometchat.io/v3/notifications/v1/settings \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '{
"preferences": {
"push": {
"includeMessageObjectSetting": true,
"includeSenderMetadataSetting": true,
"includeReceiverMetadataSetting": true,
"trimTextFieldSetting": true,
"includeMessageMetadataSetting": true,
"customJson": {}
},
"call": {
"initiatedSetting": 2,
"ongoingSetting": 2,
"cancelledSetting": 2,
"busySetting": 2,
"rejectedSetting": 2,
"unansweredSetting": 2,
"endedSetting": 2
},
"bypassPreferencesForMentions": true,
"group": {
"messagesSetting": 1,
"messagesOverride": true,
"repliesSetting": 1,
"repliesOverride": true,
"reactionsSetting": 1,
"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,
"messageEditedSetting": 1,
"messageDeletedSetting": 1
},
"oneOnOne": {
"messagesSetting": 1,
"messagesOverride": true,
"repliesSetting": 1,
"repliesOverride": true,
"reactionsSetting": 1,
"reactionsOverride": true,
"messageEditedSetting": 1,
"messageDeletedSetting": 1
},
"mute": {
"dndPreferenceOverride": true,
"mutedGroupsOverride": true,
"mutedOneOnOnesOverride": true,
"schedulePreferenceSetting": {
"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
}
},
"schedulePreferenceOverride": true
},
"email": {
"notifyForUnreadOnly": true,
"intervalInSeconds": 123,
"maxPerDay": 123,
"maxPerDayPerConversation": 123
},
"sms": {
"notifyForUnreadOnly": true,
"intervalInSeconds": 123,
"maxPerDay": 123,
"maxPerDayPerConversation": 123
}
},
"sound": {
"chat": "<string>",
"call": "<string>"
},
"templates": {
"usePrivacyTemplate": 1,
"textMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"textMessageTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"mediaMessageTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body_image": "Has sent an {{message.type}}",
"body_audio": "Has sent an {{message.type}}",
"body_video": "Has sent a {{message.type}}",
"body_file": "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_image": "Has sent an {{message.type}}",
"body_audio": "Has sent an {{message.type}}",
"body_video": "Has sent a {{message.type}}",
"body_file": "Has sent a {{message.type}}"
},
"customMessageTemplateDefault": {
"body_fallback": "<string>",
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"customMessageTemplatePrivacy": {
"body_fallback": "<string>",
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveFormTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveFormTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCardTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCardTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveSchedulerTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveSchedulerTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCustomTemplateDefault": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"interactiveCustomTemplatePrivacy": {
"titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
"titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
"body": "New text message"
},
"emailSubjectTemplateDefault": {
"subjectGroup": "While you were away...",
"subjectOneOnOne": "While you were away..."
},
"emailSubjectTemplatePrivacy": {
"subjectGroup": "While you were away...",
"subjectOneOnOne": "While you were away..."
},
"smsContentTemplateDefault": {
"bodyGroup": "You'\''ve received new messages in {{groupDetails.name}}! You can read the message at https://your-website.com.",
"bodyOneOnOne": "You'\''ve received new messages from {{sender.name}}! You can read the message at https://your-website.com."
},
"smsContentTemplatePrivacy": {
"bodyGroup": "You'\''ve received new messages in {{groupDetails.name}}! You can read the message at https://your-website.com.",
"bodyOneOnOne": "You'\''ve received new messages from {{sender.name}}! You can read the message at https://your-website.com."
}
}
}'
{
"data": {
"success": true
}
}
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Response data
A list of push notification's settings
The response is of type object
.
Was this page helpful?