community

[BETA] unlink community subgroup

Unlink one or more subgroups from a Community. They become standalone groups again. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/unlink-community-subgroup

Request

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

Path parameters

idinteger required

Instance ID

Request body

communityIdstring required
groupIdsstring[] required
removeOrphanMembersboolean

If true, members who were only in the community via these subgroups are also removed

Example request

{
  "communityId": "12345678901234@g.us",
  "groupIds": [
    "98765432109876@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.