v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB
Groups

Create group

This method is responsible for creating a group with its respective participants. Just like WhatsApp you will need to add at least one contact to be able to create a group. Due to WhatsApp's anti-spam policy, some contacts are not automatically added to the group. Read more here

post/groups

Request body

subjectstring required
participantsContactID[] required

Response

idstring required

Chat ID

namestring required

Group name

type'group' | 'contact' | 'broadcast' | 'newsletter' | 'unknown' required

Chat type

timestampinteger

Chat timestamp

name_atinteger

Group name set timestamp

created_atinteger

Group creation timestamp

created_bystring

Contact ID

unprocessed_participantsContactID[]

Сontacts that could not be added to the group

Example response

{
  "name": "Group name",
  "type": "group",
  "timestamp": 1675964377,
  "participants": [
    {
      "rank": "admin"
    }
  ],
  "name_at": 1675964377,
  "created_at": 1675964377
}