Saltar al contenido principal
POST
/
api
/
group
/
participants
/
:instance
Gestionar 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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no

​
Descripción

Endpoint único para 6 acciones sobre participantes, define la operación en el campo action. Cada participante recibe un resultado individual (success: bool), por lo que las operaciones parciales son posibles: la llamada puede devolver 200 con algunos miembros fallando.

​
Ejemplos

​
Agregar al grupo

Agrega 2 números al grupo 120363406289005073@g.us en una sola llamada (action: "add"). Los fallos por configuraciones de privacidad o números sin WhatsApp se aíslan como success: false en el 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 administrador

Promueve al número 5511999999999 a administrador mediante action: "promote". Requiere que seas super-admin del grupo (creador o promovido por otro 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"]
  }'

​
Degradar a miembro

Quita el rol de administrador al número 5511999999999 mediante action: "demote", devolviéndolo a estado de miembro común. También requiere privilegio 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"]
  }'

​
Aprobar unión al grupo (solicitud pendiente)

Aprueba una solicitud de unión pendiente pasando el LID 199789077627112@lid en participants con action: "approve". Solo funciona en grupos con 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"]
  }'

​
Rechazar unión al grupo (solicitud pendiente)

Rechaza una solicitud pendiente del número 5511999999999 mediante action: "reject". El servicio resuelve automáticamente el LID equivalente cuando pasas solo el número de teléfono. 
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"]
  }'

​
Eliminar del grupo

Elimina al número 5511999999999 del grupo mediante action: "remove". El ex-miembro puede volver a unirse mediante el enlace de invitación a menos que generes un nuevo enlace con /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"]
  }'

​
Respuesta exitosa

Cada participante recibe un resultado individual con success: true|false en el array participants. Las operaciones parciales son posibles, la llamada puede devolver 200 incluso con algunos miembros fallando (número sin WhatsApp, privacidad bloquea el agregado, ya es miembro, etc.). Inspecciona siempre cada entrada para detectar errores aislados; el campo error lleva la razón cuando 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"
    }
  ]
}
Los fallos individuales (success: false) no abortan el procesamiento de los participantes restantes. Inspecciona siempre cada entrada para detectar errores parciales (por ejemplo, número sin WhatsApp, ya es miembro, privacidad bloquea el agregado).

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json

​
Cuerpo de la solicitud

​
action
string
requerido
Uno de: add, remove, promote, demote, approve, reject.
​
identifier
string
requerido
JID, código de invitación o enlace del grupo.
​
participants
string[]
requerido
Números o JIDs objetivo de la operación. Al menos 1 elemento.

​
Tabla de acciones

actionPermisoTimeoutUso
addAdmin60sAgregar números / JIDs
removeAdmin60sEliminar miembros
promoteSuper-admin60sHacer admin
demoteSuper-admin60sQuitar admin
approveAdmin90sAprobar solicitud pendiente
rejectAdmin90sRechazar solicitud pendiente

​
Notas

  • promote / demote requieren que seas super-admin (creador del grupo o promovido por un super-admin).
  • approve / reject solo funcionan para grupos con requireAdminApproval=true y tienen un timeout más largo (90s) ya que dependen de respuestas de WhatsApp.
  • Para approve/reject, prefiere pasar el LID devuelto por /requests; si solo tienes el número de teléfono, el servicio intenta resolver el LID equivalente automáticamente.

​
Errores

HTTPMensaje
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
Envoltorio: 
{
  "success": false,
  "error": { "message": "Invalid action. Must be one of: add, remove, promote, demote, approve, reject" }
}