Skip to main content
POST
Criando grupos

Conceituação

Este método é responsável por criar um grupo com seus respectivos participantes.
Não é possível adicionar imagem durante a criação, mas você pode adicioná-la depois utilizando o método de atualizar imagem do grupo.
Você não deve passar o número conectado na lista de participantes. É necessário pelo menos um contato para criar o grupo, assim como no WhatsApp Web.
Ao criar um novo grupo, é necessário utilizar exclusivamente números de telefone. A identificação @lid não é compatível com a criação de grupos — caso seja enviada, o grupo será criado normalmente, porém o participante com @lid não será incluído e seu identificador será retornado no campo phonesNotAdded.

Atributos

string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.

Obrigatórios

boolean
obrigatório
Define se será enviado um convite privado para os participantes que não puderem ser adicionados diretamente
string
obrigatório
Nome do grupo
array
obrigatório
Lista de números de telefone dos participantes

Request Body


Response

200

string
ID/Phone do grupo criado
array
Lista de identificadores que não foram adicionados ao grupo. Um participante pode aparecer aqui por dois motivos:
  • Uso de @lid: identificadores no formato @lid não são suportados na criação de grupos. O grupo será criado normalmente, mas o participante com @lid ficará de fora e seu identificador será listado aqui.
  • Falta de permissão (autoInvite): quando um número não pode ser adicionado diretamente ao grupo e autoInvite está habilitado, um convite privado é enviado a ele. Enquanto o convite não é aceito, o número é retornado neste campo.
Link de convite do grupo

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.