Update Preferences

Update the preference for the given user.

PATCH /notifications/v1/preferences

Update Preferences

cURL

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": {},
  "oneOnOnePreferences": {},
  "mutePreferences": {
    "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
}
'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences"

payload = {
    "groupPreferences": {},
    "oneOnOnePreferences": {},
    "mutePreferences": { "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
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groupPreferences: {},
    oneOnOnePreferences: {},
    mutePreferences: {
      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
  })
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'groupPreferences' => [
        
    ],
    'oneOnOnePreferences' => [
        
    ],
    'mutePreferences' => [
        '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences"

	payload := strings.NewReader("{\n  \"groupPreferences\": {},\n  \"oneOnOnePreferences\": {},\n  \"mutePreferences\": {\n    \"schedule\": {\n      \"monday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"tuesday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"wednesday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"thursday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"friday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"saturday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"sunday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      }\n    }\n  },\n  \"usePrivacyTemplate\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"groupPreferences\": {},\n  \"oneOnOnePreferences\": {},\n  \"mutePreferences\": {\n    \"schedule\": {\n      \"monday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"tuesday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"wednesday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"thursday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"friday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"saturday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"sunday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      }\n    }\n  },\n  \"usePrivacyTemplate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/notifications/v1/preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"groupPreferences\": {},\n  \"oneOnOnePreferences\": {},\n  \"mutePreferences\": {\n    \"schedule\": {\n      \"monday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"tuesday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"wednesday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"thursday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"friday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"saturday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      },\n      \"sunday\": {\n        \"from\": 1179,\n        \"to\": 1179,\n        \"dnd\": true\n      }\n    }\n  },\n  \"usePrivacyTemplate\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "preferences": {
      "group": {
        "messagesSetting": 2,
        "messagesOverride": true,
        "repliesSetting": 2,
        "repliesOverride": true,
        "quotedRepliesSetting": 2,
        "quotedRepliesOverride": 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,
        "quotedRepliesSetting": 2,
        "quotedRepliesOverride": 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"
      },
      "pollMessageTemplateDefault": {
        "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": ""
      },
      "pollMessageTemplatePrivacy": {
        "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": ""
      },
      "reminderMessageTemplateDefault": {
        "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": ""
      },
      "reminderMessageTemplatePrivacy": {
        "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": ""
      },
      "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"
      }
    }
  }
}

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).

Query Parameters

uid · string · required

(Required) UID

Body

application/json

Response data

groupPreferences · object

Show child attributes

oneOnOnePreferences · object

Show child attributes

mutePreferences · object

Show child attributes

usePrivacyTemplate · boolean

Response

200 - application/json

A list of push notification's settings

data · any[]

meta · object