Pular para o conteúdo principal
POST
/
api
/
group
/
participants
/
:instance
Gerenciar Participantes
curl --request POST \
  --url https://api.example.com/api/group/participants/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "action": "<string>",
  "identifier": "<string>",
  "participants": [
    "<string>"
  ]
}
'

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

Endpoint único para 6 ações sobre participantes, define a operação no campo action. Cada participante recebe um resultado individual (success: bool), então operações parciais são possíveis: a chamada pode retornar 200 com alguns membros falhando.

​
Exemplos

​
Adicionar ao Grupo

Adiciona 2 números ao grupo 120363406289005073@g.us em uma única chamada (action: "add"). Falhas por privacidade ou número sem WhatsApp ficam isoladas em success: false no array participants. 
curl -X POST "https://ryzeapi.cloud/api/group/participants/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "add",
    "identifier": "120363406289005073@g.us",
    "participants": ["5511999999999", "5521988888888"]
  }'

​
Promover a Admin

Promove o número 5511999999999 a admin via action: "promote". Requer que você seja super-admin do grupo (criador ou promovido por outro super-admin). 
curl -X POST "https://ryzeapi.cloud/api/group/participants/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "promote",
    "identifier": "120363406289005073@g.us",
    "participants": ["5511999999999"]
  }'

​
Rebaixar a Membro

Remove o cargo de admin do número 5511999999999 via action: "demote", devolvendo-o ao status de membro comum. Também exige privilégio de super-admin. 
curl -X POST "https://ryzeapi.cloud/api/group/participants/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "demote",
    "identifier": "120363406289005073@g.us",
    "participants": ["5511999999999"]
  }'

​
Aprovar Entrada no Grupo (request pendente)

Aprova um pedido de entrada pendente passando o LID 199789077627112@lid em participants e action: "approve". Funciona apenas em grupos com requireAdminApproval=true. 
curl -X POST "https://ryzeapi.cloud/api/group/participants/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "approve",
    "identifier": "120363406289005073@g.us",
    "participants": ["199789077627112@lid"]
  }'

​
Rejeitar Entrada no Grupo (request pendente)

Rejeita um pedido pendente do número 5511999999999 via action: "reject". O serviço resolve automaticamente o LID equivalente quando você passa apenas o telefone. 
curl -X POST "https://ryzeapi.cloud/api/group/participants/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "reject",
    "identifier": "120363406289005073@g.us",
    "participants": ["5511999999999"]
  }'

​
Remover do Grupo

Remove o número 5511999999999 do grupo via action: "remove". O ex-membro pode reentrar pelo link de convite, a menos que você gere um novo link com /reset-link. 
curl -X POST "https://ryzeapi.cloud/api/group/participants/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "remove",
    "identifier": "120363406289005073@g.us",
    "participants": ["5511999999999"]
  }'

​
Resposta de sucesso

Cada participante recebe um resultado individual com success: true|false no array participants. Operações parciais são possíveis, a chamada pode retornar 200 mesmo com alguns membros falhando (número sem WhatsApp, privacidade impede add, já é membro, etc.). Sempre inspecione cada entrada para detectar erros isolados; o campo error traz o motivo quando success=false.
200 OK (parcial)
{
  "success": true,
  "message": "Successfully added 2 participant(s)",
  "groupJid": "120363406289005073@g.us",
  "action": "add",
  "participants": [
    {
      "jid": "5511999999999@s.whatsapp.net",
      "isAdmin": false,
      "isSuperAdmin": false,
      "success": true
    },
    {
      "jid": "5521988888888@s.whatsapp.net",
      "isAdmin": false,
      "isSuperAdmin": false,
      "success": false,
      "error": "user not on whatsapp"
    }
  ]
}
Falhas individuais (success: false) não abortam o processamento dos demais participantes. Sempre inspecione cada entrada para detectar erros parciais (ex.: número sem WhatsApp, já membro, privacidade impede add).

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

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

​
Request body

​
action
string
obrigatório
Uma de: add, remove, promote, demote, approve, reject.
​
identifier
string
obrigatório
JID, código de convite ou link do grupo.
​
participants
string[]
obrigatório
Números ou JIDs alvo da operação. Pelo menos 1 item.

​
Tabela de ações

actionPermissãoTimeoutUso
addAdmin60sAdicionar números / JIDs
removeAdmin60sRemover membros
promoteSuper-admin60sTornar admin
demoteSuper-admin60sRemover admin
approveAdmin90sAprovar request pendente
rejectAdmin90sRejeitar request pendente

​
Notas

  • promote / demote exigem que você seja super-admin (criador do grupo ou promovido por um super-admin).
  • approve / reject só funcionam para grupos com requireAdminApproval=true e tem timeout maior (90s) por dependerem de respostas do WhatsApp.
  • Em approve/reject, prefira passar o LID retornado por /requests, caso só tenha o telefone, o serviço tenta resolver o LID equivalente automaticamente.

​
Erros

HTTPMensagem
400Invalid action. Must be one of: add, remove, promote, demote, approve, reject
400At least one participant is required
400Identifier is required
403Not authorized to perform this action (must be admin)
404Group not found or you are not a member of this group
Envelope: 
{
  "success": false,
  "error": { "message": "Invalid action. Must be one of: add, remove, promote, demote, approve, reject" }
}