Skip to main content
POST
/
api
/
{session}
/
groups
Criar um novo grupo
curl --request POST \
  --url https://{host}/api/{session}/groups \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "Meu Grupo",
  "participants": [
    {
      "id": "[email protected]"
    }
  ]
}
'
{
  "id": "[email protected]",
  "subject": "Meu Novo Grupo",
  "creation": 1234567890
}

​
Descrição

Este endpoint permite criar um novo grupo no WhatsApp com um nome e lista de participantes especificados.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp

​
Body

{
  "name": "Meu Grupo",
  "participants": [
    "[email protected]"
  ]
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
namestring✅ SimNome do grupo a ser criado
participantsarray✅ SimArray de JIDs dos participantes do grupo. Formato: ["[email protected]", "[email protected]"]

​
Resposta

​
id
string
ID do grupo criado no formato [email protected]
{
  "id": "[email protected]",
  "subject": "Meu Novo Grupo",
  "creation": 1234567890
}

​
Códigos de Status

  • 200 - Grupo criado com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/groups \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Meu Novo Grupo",
    "participants": ["[email protected]", "[email protected]"]
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
session
string
required

Nome da sessão (instanceName)

Body

application/json
​
name
string
required

Nome do grupo

Example:

"Meu Grupo"

​
participants
object[]
required

Array de participantes do grupo

Response

201 - undefined