Configurações do grupo
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
Configurações do grupo
Altera as preferências e configurações do grupo
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
update-group-settings
Configurações do grupo
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_bodyConceituação
Este método permite você alterar as preferências do grupo.Somente administradores podem alterar as preferências do grupo.
Atributos
Header
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.
Obrigatórios
string
obrigatório
ID/Phone do grupo
boolean
obrigatório
Apenas administradores podem enviar mensagens
boolean
obrigatório
Apenas administradores podem alterar configurações do grupo
boolean
obrigatório
Aprovação de administrador necessária para novos membros
boolean
obrigatório
Apenas administradores podem adicionar membros
Request Body
{
"phone": "120363019502650977-group",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": false,
"adminOnlyAddMember": true
}
Response
200
{
"value": true
}
405
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.415
Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.⌘I