Skip to main content

Group information by invitation

GET 
/api/v2/instance/:instanceId/group/invitation/:code

This endpoint allows you to retrieve recorded information from a WhatsApp group via a shared invitation. The invitation is used to identify the group you want information about.

Request​

Path Parameters

    instanceId stringrequired

    The unique identifier of the group whose settings will be changed.

    code stringrequired

    Enter your invitation code.

Responses​

Invitation group data

Schema
    id stringrequired
    owner stringrequired
    subject stringrequired
    subjectOwner string
    subjectTime number
    creation string
    leave number
    desc string
    descOwner string
    descId string
    restrict boolean
    announce boolean
    size number
    participants object[]required
  • Array [
    • id stringrequired
    name string
    notify string
    verifiedName string
    imgUrl string
    status string
    isAdmin boolean
    isSuperAdmin boolean
    admin string

    Default value: admin | superadmin

  • ]
    • ephemeralDuration number
    inviteCode string
Loading...