Update Settings

Update preferences, templates and sounds for the given app.

PATCH /notifications/v1/settings

Update Settings

cURL

curl --request PATCH \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/settings \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data @- <<EOF
{
  "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}}"
    },
    "pollMessageTemplateDefault": {
      "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"
    },
    "pollMessageTemplatePrivacy": {
      "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"
    },
    "reminderMessageTemplateDefault": {
      "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"
    },
    "reminderMessageTemplatePrivacy": {
      "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"
    },
    "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"
    },
    "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."
    },
    "userMentionTemplatePrivacy": {
      "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
      "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
      "bodyOneOnOne": "{{message.data.entities.sender.entity.name}} mentioned you: {{message.data.text}}",
      "bodyGroup": "{{message.data.entities.sender.entity.name}} mentioned you in {{message.data.entities.receiver.entity.name}}: {{message.data.text}}",
      "body_fallback": "New mention"
    },
    "groupMentionTemplatePrivacy": {
      "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
      "body": "{{message.data.entities.sender.entity.name}} mentioned everyone: {{message.data.text}}",
      "body_fallback": "New mention"
    },
    "groupMentionTemplateDefault": {
      "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
      "body": "{{message.data.entities.sender.entity.name}} mentioned everyone: {{message.data.text}}",
      "body_fallback": "New mention"
    },
    "userMentionTemplateDefault": {
      "titleOneOnOne": "{{message.data.entities.sender.entity.name}}",
      "titleGroup": "{{message.data.entities.sender.entity.name}} @ {{message.data.entities.receiver.entity.name}}",
      "bodyOneOnOne": "{{message.data.entities.sender.entity.name}} mentioned you: {{message.data.text}}",
      "bodyGroup": "{{message.data.entities.sender.entity.name}} mentioned you in {{message.data.entities.receiver.entity.name}}: {{message.data.text}}",
      "body_fallback": "New mention"
    }
  }
}
EOF

200

{
  "data": {
    "success": true
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json

Response data

preferences · object

Show child attributes

sound · object

Show child attributes

templates · object

Show child attributes

Response

200 - application/json

A list of push notification's settings

data · any[]