Pular para o conteúdo principal
POST
/
api
/
group
/
create
/
:instance
Criar Grupo
curl --request POST \
  --url https://api.example.com/api/group/create/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "name": "<string>",
  "participants": [
    "<string>"
  ],
  "description": "<string>",
  "image": "<string>",
  "communityJid": "<string>",
  "groupSettings": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não

​
Descrição

Cria um grupo de WhatsApp e o vincula opcionalmente a uma comunidade existente (communityJid). Você pode definir nome, descrição, foto e permissões iniciais (groupSettings) na mesma chamada. A foto e a descrição são aplicadas em chamadas subsequentes após a criação do grupo.

​
Exemplos

​
Mínimo

Cria um grupo “Time de Dev” com 2 participantes iniciais (5511999999999, 5521988888888), sem descrição, foto, comunidade nem permissões customizadas. 
curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Time de Dev",
    "participants": ["5511999999999", "5521988888888"]
  }'

​
Com descrição e foto

Cria o grupo já com a descrição “Discussões técnicas” e foto vinda de uma URL pública. Descrição e imagem são aplicadas em chamadas subsequentes após a criação do grupo. 
curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Time de Dev",
    "description": "Discussões técnicas",
    "image": "https://exemplo.com/logo.png",
    "participants": ["5511999999999", "5521988888888"]
  }'

​
Com permissões

Cria um grupo “Anúncios” com restrições iniciais: somente admins podem enviar mensagens (membersCanSendMessages: false) e novas entradas precisam de aprovação (requireAdminApproval: true). 
curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Anúncios",
    "participants": ["5511999999999"],
    "groupSettings": {
      "membersCanSendMessages": false,
      "requireAdminApproval": true
    }
  }'

​
Vinculado a comunidade

Cria o grupo “Subgrupo Geral” já vinculado à comunidade 120363406289005073@g.us via communityJid, evitando o passo extra de chamar /community/link após a criação. 
curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Subgrupo Geral",
    "participants": ["5511999999999"],
    "communityJid": "120363406289005073@g.us"
  }'

​
Resposta de sucesso

A resposta inclui o group.jid recém-criado (use-o como identifier nas chamadas subsequentes), o inviteCode e inviteLink prontos para compartilhar e a lista de participants já marcada com isAdmin/isSuperAdmin. O criador entra automaticamente como super-admin. Os campos groupSettings refletem as permissões iniciais (defaults ou o que foi enviado).
200 OK
{
  "success": true,
  "message": "Group created successfully",
  "group": {
    "name": "Time de Dev",
    "jid": "120363406289005073@g.us",
    "description": "Discussões técnicas",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "participantCount": 3,
    "participants": [
      { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
    ],
    "groupSettings": {
      "membersCanEditInfo": true,
      "membersCanSendMessages": true,
      "membersCanAddOthers": false,
      "requireAdminApproval": false
    },
    "isCommunity": false,
    "isParent": false,
    "linkedParentJid": null
  }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância (ex.: $Instance_Name).

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
name
string
obrigatório
Nome do grupo. Máximo de 25 caracteres.
​
participants
string[]
obrigatório
Lista de números (5511999999999) ou JIDs (5511999999999@s.whatsapp.net). Pelo menos 1 item.
​
description
string
Descrição (tópico) do grupo. Aplicada via SetGroupTopic após a criação.
​
image
string
URL pública ou data URI base64. A imagem é convertida para JPEG.
​
communityJid
string
Cria o grupo já vinculado a uma comunidade (parent group).
​
groupSettings
object
Permissões iniciais. Subcampos: membersCanEditInfo, membersCanSendMessages, membersCanAddOthers, requireAdminApproval.

​
Notas

  • O criador do grupo entra automaticamente como super-admin.
  • Números inválidos (não registrados no WhatsApp) são rejeitados; o erro indica qual participante falhou.
  • Se image for passada e o upload falhar, a criação do grupo segue normalmente, o erro de imagem não é fatal nesta rota. Use PUT /update para reaplicar a foto.

​
Erros

HTTPMensagem
400The 'name' field is required
400At least one participant is required
400group name must be 25 characters or less
400invalid participant <number>: <reason>
400Instance is not connected to WhatsApp
429rate limit exceeded (429): wait before creating again
Envelope: 
{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}