Skip to main content
PUT
Enable Announcement Group Protection
Notes 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

Request Body

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)