contact

get common groups with contact

Get list of groups that are in common between you and the specified contact

post/instances/{id}/client/action/get-common-groups

Request

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

Path parameters

idinteger required

Instance ID

Request body

contactIdstring required

Contact ID: <number>@c.us or <lid>@lid.

Example request

{
  "contactId": "1234567890@c.us"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully retrieved common groups.

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",
    "data": [
      {
        "server": "g.us",
        "user": "120363354333444555",
        "_serialized": "120363354333444555@g.us"
      }
    ]
  }
}

Changes

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