Update APNS Providers
curl --request PUT \
--url https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"providerId": "<string>",
"keyId": "<string>",
"teamId": "<string>",
"bundleId": "<string>",
"p8KeyFilename": "<string>",
"p8Key": "<string>",
"includeContentAvailable": true,
"includeMutableContent": true,
"productionMode": true
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns"
payload = {
"providerId": "<string>",
"keyId": "<string>",
"teamId": "<string>",
"bundleId": "<string>",
"p8KeyFilename": "<string>",
"p8Key": "<string>",
"includeContentAvailable": True,
"includeMutableContent": True,
"productionMode": 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>',
keyId: '<string>',
teamId: '<string>',
bundleId: '<string>',
p8KeyFilename: '<string>',
p8Key: '<string>',
includeContentAvailable: true,
includeMutableContent: true,
productionMode: true
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns', 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/apns",
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>',
'keyId' => '<string>',
'teamId' => '<string>',
'bundleId' => '<string>',
'p8KeyFilename' => '<string>',
'p8Key' => '<string>',
'includeContentAvailable' => true,
'includeMutableContent' => true,
'productionMode' => 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/apns"
payload := strings.NewReader("{\n \"providerId\": \"<string>\",\n \"keyId\": \"<string>\",\n \"teamId\": \"<string>\",\n \"bundleId\": \"<string>\",\n \"p8KeyFilename\": \"<string>\",\n \"p8Key\": \"<string>\",\n \"includeContentAvailable\": true,\n \"includeMutableContent\": true,\n \"productionMode\": true\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/apns")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"providerId\": \"<string>\",\n \"keyId\": \"<string>\",\n \"teamId\": \"<string>\",\n \"bundleId\": \"<string>\",\n \"p8KeyFilename\": \"<string>\",\n \"p8Key\": \"<string>\",\n \"includeContentAvailable\": true,\n \"includeMutableContent\": true,\n \"productionMode\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns")
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 \"keyId\": \"<string>\",\n \"teamId\": \"<string>\",\n \"bundleId\": \"<string>\",\n \"p8KeyFilename\": \"<string>\",\n \"p8Key\": \"<string>\",\n \"includeContentAvailable\": true,\n \"includeMutableContent\": true,\n \"productionMode\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true
}
}APNS Provider
Update APNS Providers
Update existing APNS provider for the given app.
PUT
/
notifications
/
push
/
v1
/
providers
/
apns
Update APNS Providers
curl --request PUT \
--url https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"providerId": "<string>",
"keyId": "<string>",
"teamId": "<string>",
"bundleId": "<string>",
"p8KeyFilename": "<string>",
"p8Key": "<string>",
"includeContentAvailable": true,
"includeMutableContent": true,
"productionMode": true
}
'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns"
payload = {
"providerId": "<string>",
"keyId": "<string>",
"teamId": "<string>",
"bundleId": "<string>",
"p8KeyFilename": "<string>",
"p8Key": "<string>",
"includeContentAvailable": True,
"includeMutableContent": True,
"productionMode": 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>',
keyId: '<string>',
teamId: '<string>',
bundleId: '<string>',
p8KeyFilename: '<string>',
p8Key: '<string>',
includeContentAvailable: true,
includeMutableContent: true,
productionMode: true
})
};
fetch('https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns', 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/apns",
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>',
'keyId' => '<string>',
'teamId' => '<string>',
'bundleId' => '<string>',
'p8KeyFilename' => '<string>',
'p8Key' => '<string>',
'includeContentAvailable' => true,
'includeMutableContent' => true,
'productionMode' => 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/apns"
payload := strings.NewReader("{\n \"providerId\": \"<string>\",\n \"keyId\": \"<string>\",\n \"teamId\": \"<string>\",\n \"bundleId\": \"<string>\",\n \"p8KeyFilename\": \"<string>\",\n \"p8Key\": \"<string>\",\n \"includeContentAvailable\": true,\n \"includeMutableContent\": true,\n \"productionMode\": true\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/apns")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"providerId\": \"<string>\",\n \"keyId\": \"<string>\",\n \"teamId\": \"<string>\",\n \"bundleId\": \"<string>\",\n \"p8KeyFilename\": \"<string>\",\n \"p8Key\": \"<string>\",\n \"includeContentAvailable\": true,\n \"includeMutableContent\": true,\n \"productionMode\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/notifications/push/v1/providers/apns")
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 \"keyId\": \"<string>\",\n \"teamId\": \"<string>\",\n \"bundleId\": \"<string>\",\n \"p8KeyFilename\": \"<string>\",\n \"p8Key\": \"<string>\",\n \"includeContentAvailable\": true,\n \"includeMutableContent\": true,\n \"productionMode\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true
}
}For the complete error reference, see Error Guide.
Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Body
application/json
Response
200 - application/json
A list of push notification's settings
Was this page helpful?
⌘I