Create Community
Supported & TestedCreate a WhatsApp Community through the Waplix Community API.
POSThttps://api.waplix.io/api/v1/communities/create
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| subject | string | Required | Required community title |
| description | string | Optional | Optional community description |
| participants | array | Optional | Optional array of phone numbers or JIDs. May be empty. |
instance_id
stringReq Required Waplix instance id
subject
stringReq Required community title
description
stringOpt Optional community description
participants
arrayOpt Optional array of phone numbers or JIDs. May be empty.
Usage Notes
Community IDs use the @g.us JID format, for example: 120363000000000001@g.us. Emits community.created webhook after success.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/communities/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance",
"subject": "Demo Community",
"description": "Community created for API documentation.",
"participants": []
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"community_id": "120363000000000001@g.us",
"subject": "Demo Community",
"description": "Community created for API documentation.",
"participants": [],
"status": "created"
}
} Was this page helpful?