Add Friends
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"accepted": [
"<string>"
]
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends"
payload = { "accepted": ["<string>"] }
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({accepted: ['<string>']})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends', 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/users/{uid}/friends",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accepted' => [
'<string>'
]
]),
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/users/{uid}/friends"
payload := strings.NewReader("{\n \"accepted\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accepted\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accepted\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"accepted": {
"superhero2": {
"success": true,
"message": "Created relationship with status accepted."
},
"superhero3": {
"success": true,
"message": "Created relationship with status accepted."
}
}
}
}Friends
Add Friends
The API allows to add multiple friends for a given UID.
POST
/
users
/
{uid}
/
friends
Add Friends
curl --request POST \
--url https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--data '
{
"accepted": [
"<string>"
]
}
'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends"
payload = { "accepted": ["<string>"] }
headers = {
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({accepted: ['<string>']})
};
fetch('https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends', 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/users/{uid}/friends",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accepted' => [
'<string>'
]
]),
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/users/{uid}/friends"
payload := strings.NewReader("{\n \"accepted\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends")
.header("apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accepted\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/users/{uid}/friends")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accepted\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"accepted": {
"superhero2": {
"success": true,
"message": "Created relationship with status accepted."
},
"superhero3": {
"success": true,
"message": "Created relationship with status accepted."
}
}
}
}Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Path Parameters
An UID of a user.
Body
application/json
The array of UIDs of the friends.
Response
200 - application/json
Added Friend
Show child attributes
Show child attributes
⌘I