group

accept group invite

Accept a group invitation. Pass either inviteCode (the invite code or the full invite link) — identical to accept-invite — or inviteData, the invite object carried by a group invite message.

post/instances/{id}/client/action/accept-group-invite

Request

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

Path parameters

idinteger required

Instance ID

Request body

inviteCodestring

The group invite code, or the full invite link. Ignored when inviteData is given.

Example request

{
  "inviteCode": "abcdefghijk",
  "inviteData": {
    "fromId": "<xxxxxxxxx>@c.us",
    "groupId": "<yyyyyyyyyyyyyyy>@g.us"
  }
}

Response

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

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

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

Changes

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