Gerenciar Participantes

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>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({action: '<string>', identifier: '<string>', participants: ['<string>']})
};

fetch('https://api.example.com/api/group/participants/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/group/participants/:instance"

payload = {
    "action": "<string>",
    "identifier": "<string>",
    "participants": ["<string>"]
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/participants/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action:       "add",
    identifier:   "120363406289005073@g.us",
    participants: ["5511999999999", "5521988888888"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/participants/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "action":       "add",
        "identifier":   "120363406289005073@g.us",
        "participants": ["5511999999999", "5521988888888"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "action": "add",
        "identifier": "120363406289005073@g.us",
        "participants": ["5511999999999", "5521988888888"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/participants/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/participants/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action:       "promote",
    identifier:   "120363406289005073@g.us",
    participants: ["5511999999999"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/participants/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "action":       "promote",
        "identifier":   "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "action": "promote",
        "identifier": "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/participants/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/participants/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action:       "demote",
    identifier:   "120363406289005073@g.us",
    participants: ["5511999999999"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/participants/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "action":       "demote",
        "identifier":   "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "action": "demote",
        "identifier": "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/participants/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/participants/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action:       "approve",
    identifier:   "120363406289005073@g.us",
    participants: ["199789077627112@lid"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/participants/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "action":       "approve",
        "identifier":   "120363406289005073@g.us",
        "participants": ["199789077627112@lid"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "action": "approve",
        "identifier": "120363406289005073@g.us",
        "participants": ["199789077627112@lid"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/participants/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/participants/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action:       "reject",
    identifier:   "120363406289005073@g.us",
    participants: ["5511999999999"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/participants/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "action":       "reject",
        "identifier":   "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "action": "reject",
        "identifier": "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/participants/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/participants/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    action:       "remove",
    identifier:   "120363406289005073@g.us",
    participants: ["5511999999999"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/participants/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "action":       "remove",
        "identifier":   "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "action": "remove",
        "identifier": "120363406289005073@g.us",
        "participants": ["5511999999999"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/participants/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

Uma de: add, remove, promote, demote, approve, reject.

string

obrigatório

JID, código de convite ou link do grupo.

string[]

obrigatório

Números ou JIDs alvo da operação. Pelo menos 1 item.

Tabela de ações

`action`	Permissão	Timeout	Uso
`add`	Admin	60s	Adicionar números / JIDs
`remove`	Admin	60s	Remover membros
`promote`	Super-admin	60s	Tornar admin
`demote`	Super-admin	60s	Remover admin
`approve`	Admin	90s	Aprovar request pendente
`reject`	Admin	90s	Rejeitar 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

HTTP	Mensagem
400	`Invalid action. Must be one of: add, remove, promote, demote, approve, reject`
400	`At least one participant is required`
400	`Identifier is required`
403	`Not authorized to perform this action (must be admin)`
404	`Group 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" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Gerenciar Participantes

Descrição

Exemplos

Adicionar ao Grupo

Promover a Admin

Rebaixar a Membro

Aprovar Entrada no Grupo (request pendente)

Rejeitar Entrada no Grupo (request pendente)

Remover do Grupo

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Tabela de ações

Notas

Erros

​Descrição

​Exemplos

​Adicionar ao Grupo

​Promover a Admin

​Rebaixar a Membro

​Aprovar Entrada no Grupo (request pendente)

​Rejeitar Entrada no Grupo (request pendente)

​Remover do Grupo

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Tabela de ações

​Notas

​Erros

Descrição

Exemplos

Adicionar ao Grupo

Promover a Admin

Rebaixar a Membro

Aprovar Entrada no Grupo (request pendente)

Rejeitar Entrada no Grupo (request pendente)

Remover do Grupo

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Tabela de ações

Notas

Erros