v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB

group

create group

Creates a new group with specified name and participants

post/instances/{id}/client/action/create-group

Path parameters

idinteger required

Instance ID of the client

Request body

groupNamestring required

Name of the group to be created

groupParticipantsstring[] required

Array of contact IDs to add to the group

Example request

{
  "groupName": "My Group Name",
  "groupParticipants": [
    "123456789@c.us",
    "987654321@c.us"
  ]
}

Response

Group created successfully

status'success' | 'error'

Example response

{
  "status": "success",
  "data": {
    "gid": {
      "server": "g.us",
      "user": "123456789123456789",
      "_serialized": "123456789123456789@g.us"
    },
    "missingParticipants": [
      "123456789@c.us"
    ]
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/create-group"
  }
}