community

[BETA] create a community

Create a new Community (parent group containing subgroups). When createGeneralChat is true (default), the service also provisions a default 'General' announcement subgroup. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/create-community

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/create-community
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

titlestring required
descriptionstring
closedboolean

If true, joining subgroups requires admin approval

allowNonAdminSubGroupCreationboolean

If true, non-admin members can create subgroups

createGeneralChatboolean

If true, provision the default 'General' announcement subgroup

existingGroupIdsstring[]

IDs of existing standalone groups to link as subgroups immediately after creation

Example request

{
  "title": "My Community",
  "description": "A community for customers of our store",
  "closed": true,
  "allowNonAdminSubGroupCreation": true,
  "createGeneralChat": true,
  "existingGroupIds": [
    "12345678901234@g.us"
  ]
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.