v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
community

[BETA] get community by id

Retrieve a specific Community by its ID. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/get-community-by-id

Path parameters

idinteger required

Instance ID

Request body

communityIdstring required

Example request

{
  "communityId": "12345678901234@g.us"
}

Response

status'success' | 'error'
dataobject

Example response

{
  "status": "success"
}