Skip to main content

Creating WhatsApp Groups

POST 
/api/v2/instance/:instanceId/group

This route enables the creation of new groups on WhatsApp, where members can come together to exchange messages and share information. When creating a group, it's necessary to provide a mandatory subject for identification, as well as the option to add an optional description that provides more context about the group's purpose.

Request​

Path Parameters

    instanceId stringrequired

    ID of the instance.

Body

required
  • create (object required):
  • participants (array of strings, required): A list containing the phone numbers of members who will be included in the group.
  • subject (string, required): The title or subject of the group, which must be provided during creation.
  • description (string, optional): An optional description that offers a more detailed view of the group.
    create object
    participants string[]required

    Default value: 5531900000000,5512911111111

    subject Subject

    Required to group created.

    description Description

Responses​

GroupCreateResponse

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...