Group settings
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": true,
"adminOnlyAddMember": true
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings"
payload = {
"phone": "<string>",
"adminOnlyMessage": True,
"adminOnlySettings": True,
"requireAdminApproval": True,
"adminOnlyAddMember": True
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '<string>',
adminOnlyMessage: true,
adminOnlySettings: true,
requireAdminApproval: true,
adminOnlyAddMember: true
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings', 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://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings",
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([
'phone' => '<string>',
'adminOnlyMessage' => true,
'adminOnlySettings' => true,
'requireAdminApproval' => true,
'adminOnlyAddMember' => true
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"adminOnlyMessage\": true,\n \"adminOnlySettings\": true,\n \"requireAdminApproval\": true,\n \"adminOnlyAddMember\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"adminOnlyMessage\": true,\n \"adminOnlySettings\": true,\n \"requireAdminApproval\": true,\n \"adminOnlyAddMember\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"<string>\",\n \"adminOnlyMessage\": true,\n \"adminOnlySettings\": true,\n \"requireAdminApproval\": true,\n \"adminOnlyAddMember\": true\n}"
response = http.request(request)
puts response.read_bodyGroups
Group settings
Change group preferences and settings
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
update-group-settings
Group settings
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": true,
"adminOnlyAddMember": true
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings"
payload = {
"phone": "<string>",
"adminOnlyMessage": True,
"adminOnlySettings": True,
"requireAdminApproval": True,
"adminOnlyAddMember": True
}
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '<string>',
adminOnlyMessage: true,
adminOnlySettings: true,
requireAdminApproval: true,
adminOnlyAddMember: true
})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings', 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://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings",
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([
'phone' => '<string>',
'adminOnlyMessage' => true,
'adminOnlySettings' => true,
'requireAdminApproval' => true,
'adminOnlyAddMember' => true
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"adminOnlyMessage\": true,\n \"adminOnlySettings\": true,\n \"requireAdminApproval\": true,\n \"adminOnlyAddMember\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"adminOnlyMessage\": true,\n \"adminOnlySettings\": true,\n \"requireAdminApproval\": true,\n \"adminOnlyAddMember\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"<string>\",\n \"adminOnlyMessage\": true,\n \"adminOnlySettings\": true,\n \"requireAdminApproval\": true,\n \"adminOnlyAddMember\": true\n}"
response = http.request(request)
puts response.read_bodyOverview
This method allows you to change group preferences.Only administrators can change group preferences.
Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Required
string
required
Group ID/Phone
boolean
required
Only administrators can send messages
boolean
required
Only administrators can change group settings
boolean
required
Admin approval required for new members
boolean
required
Only administrators can add members
Request Body
{
"phone": "120363019502650977-group",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": false,
"adminOnlyAddMember": true
}
Response
200
{
"value": true
}
405
Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.415
If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.⌘I