Update FCM Provider

Update existing FCM provider for the given app.

PUT /notifications/push/v1/providers/fcm

Update FCM Provider

cURL

curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/fcm \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "providerId": "<string>",
  "serviceAccountFilename": "<string>",
  "serviceAccountCreds": {
    "project_id": "<string>",
    "client_email": "<string>",
    "private_key": "<string>",
    "private_key_id": "<string>"
  },
  "notificationInPayload": {
    "ios": {
      "chat": true,
      "call": true
    },
    "android": {
      "chat": true,
      "call": true
    },
    "web": {
      "chat": true,
      "call": true
    }
  }
}
'

import requests

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

payload = {
    "providerId": "<string>",
    "serviceAccountFilename": "<string>",
    "serviceAccountCreds": {
        "project_id": "<string>",
        "client_email": "<string>",
        "private_key": "<string>",
        "private_key_id": "<string>"
    },
    "notificationInPayload": {
        "ios": {
            "chat": True,
            "call": True
        },
        "android": {
            "chat": True,
            "call": True
        },
        "web": {
            "chat": True,
            "call": True
        }
    }
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    providerId: '<string>',
    serviceAccountFilename: '<string>',
    serviceAccountCreds: {
      project_id: '<string>',
      client_email: '<string>',
      private_key: '<string>',
      private_key_id: '<string>'
    },
    notificationInPayload: {
      ios: {chat: true, call: true},
      android: {chat: true, call: true},
      web: {chat: true, call: true}
    }
  })
};

fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/fcm', 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/push/v1/providers/fcm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'providerId' => '<string>',
    'serviceAccountFilename' => '<string>',
    'serviceAccountCreds' => [
        'project_id' => '<string>',
        'client_email' => '<string>',
        'private_key' => '<string>',
        'private_key_id' => '<string>'
    ],
    'notificationInPayload' => [
        'ios' => [
                'chat' => true,
                'call' => true
        ],
        'android' => [
                'chat' => true,
                'call' => true
        ],
        'web' => [
                'chat' => true,
                'call' => 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/push/v1/providers/fcm"

	payload := strings.NewReader("{\n  \"providerId\": \"<string>\",\n  \"serviceAccountFilename\": \"<string>\",\n  \"serviceAccountCreds\": {\n    \"project_id\": \"<string>\",\n    \"client_email\": \"<string>\",\n    \"private_key\": \"<string>\",\n    \"private_key_id\": \"<string>\"\n  },\n  \"notificationInPayload\": {\n    \"ios\": {\n      \"chat\": true,\n      \"call\": true\n    },\n    \"android\": {\n      \"chat\": true,\n      \"call\": true\n    },\n    \"web\": {\n      \"chat\": true,\n      \"call\": true\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/fcm")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providerId\": \"<string>\",\n  \"serviceAccountFilename\": \"<string>\",\n  \"serviceAccountCreds\": {\n    \"project_id\": \"<string>\",\n    \"client_email\": \"<string>\",\n    \"private_key\": \"<string>\",\n    \"private_key_id\": \"<string>\"\n  },\n  \"notificationInPayload\": {\n    \"ios\": {\n      \"chat\": true,\n      \"call\": true\n    },\n    \"android\": {\n      \"chat\": true,\n      \"call\": true\n    },\n    \"web\": {\n      \"chat\": true,\n      \"call\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"providerId\": \"<string>\",\n  \"serviceAccountFilename\": \"<string>\",\n  \"serviceAccountCreds\": {\n    \"project_id\": \"<string>\",\n    \"client_email\": \"<string>\",\n    \"private_key\": \"<string>\",\n    \"private_key_id\": \"<string>\"\n  },\n  \"notificationInPayload\": {\n    \"ios\": {\n      \"chat\": true,\n      \"call\": true\n    },\n    \"android\": {\n      \"chat\": true,\n      \"call\": true\n    },\n    \"web\": {\n      \"chat\": true,\n      \"call\": true\n    }\n  }\n}"

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

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

providerId · string

serviceAccountFilename · string

serviceAccountCreds · object

Show child attributes

notificationInPayload · object

Show child attributes

Response

200 - application/json

A list of push notification's settings

data · any[]

meta · object