Enable Announcement Group Protection
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": true
}'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard"
payload = { "value": True }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({value: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard', 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-announcement-guard",
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([
'value' => 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-announcement-guard"
payload := strings.NewReader("{\n \"value\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": true\n}"
response = http.request(request)
puts response.read_bodyInstance
Enable Announcement Group Protection
Protect your announcement groups from scam messages by automatically removing content sent by participants who are not admins, and receiving the sender’s data via webhook.
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-announcement-guard
Enable Announcement Group Protection
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": true
}'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard"
payload = { "value": True }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({value: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard', 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-announcement-guard",
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([
'value' => 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-announcement-guard"
payload := strings.NewReader("{\n \"value\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": true\n}"
response = http.request(request)
puts response.read_bodyNotes about this endpoint
- Only works in announcement groups where the instance is an admin.
- Ignores admins.
- Each message generates a webhook event.
- The author is not removed automatically.
Overview
The Anti-Scam Protection in Announcement Groups automatically removes, for all participants, messages sent by scammers — that is, participants who are not admins — in community announcement groups, where only admins can send messages. Whenever a message is removed, you receive a webhook event containing the author’s data. This way, your application can identify the responsible party and take the necessary action, such as removing them from the group.Attributes
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Headers
| Header | Value |
|---|---|
Client-Token | Account security token |
Content-Type | application/json |
Request Body
{
"value": true
}
boolean
required
Value that toggles the protection, TRUE enables and FALSE disables (Default = FALSE)
Response
200
boolean
Returned with the status provided in the request (TRUE or FALSE)