Send Community Announcement
Supported & TestedSend an announcement message to a WhatsApp Community announcement group.
POSThttps://api.waplix.io/api/v1/communities/announcement-send
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| message | string | Required | Required announcement text |
| community_id | string | Optional | Optional community id used to resolve the announcement group |
| announcement_group_id | boolean | Optional | Optional announcement group id ending with @g.us |
instance_id
stringReq Required Waplix instance id
message
stringReq Required announcement text
community_id
stringOpt Optional community id used to resolve the announcement group
announcement_group_id
booleanOpt Optional announcement group id ending with @g.us
Usage Notes
Send an announcement to a community announcement group. Emits community.announcement.sent webhook after success.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/communities/announcement-send" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance",
"announcement_group_id": "120363000000000002@g.us",
"message": "Hello from Waplix API docs."
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"announcement_group_id": "120363000000000002@g.us",
"message_id": "MSG_DEMO_001",
"status": "sent"
}
} Was this page helpful?