Skip to main content
POST
/
api
/
group
/
participants
/
:instance
Manage Participants
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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no

​
Description

Single endpoint for 6 actions on participants, set the operation in the action field. Each participant gets an individual result (success: bool), so partial operations are possible: the call may return 200 with some members failing.

​
Examples

​
Add to Group

Adds 2 numbers to the group 120363406289005073@g.us in a single call (action: "add"). Failures from privacy settings or numbers without WhatsApp are isolated as success: false in the participants array. 
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"]
  }'

​
Promote to Admin

Promotes the number 5511999999999 to admin via action: "promote". Requires that you are super-admin of the group (creator or promoted by another 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"]
  }'

​
Demote to Member

Removes the admin role from the number 5511999999999 via action: "demote", returning them to plain member status. Also requires super-admin privilege. 
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"]
  }'

​
Approve Group Join (pending request)

Approves a pending join request by passing the LID 199789077627112@lid in participants with action: "approve". Only works in groups with 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"]
  }'

​
Reject Group Join (pending request)

Rejects a pending request from the number 5511999999999 via action: "reject". The service automatically resolves the equivalent LID when you pass only the phone number. 
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"]
  }'

​
Remove from Group

Removes the number 5511999999999 from the group via action: "remove". The ex-member can rejoin via the invite link unless you generate a new link with /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"]
  }'

​
Success response

Each participant receives an individual result with success: true|false in the participants array. Partial operations are possible, the call may return 200 even with some members failing (number without WhatsApp, privacy blocks add, already a member, etc.). Always inspect each entry to detect isolated errors; the error field carries the reason when success=false.
200 OK (partial)
{
  "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"
    }
  ]
}
Individual failures (success: false) do not abort processing of the remaining participants. Always inspect each entry to detect partial errors (e.g., number without WhatsApp, already a member, privacy blocks add).

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.
​
Content-Type
string
required
application/json

​
Request body

​
action
string
required
One of: add, remove, promote, demote, approve, reject.
​
identifier
string
required
Group JID, invite code, or link.
​
participants
string[]
required
Numbers or JIDs targeted by the operation. At least 1 item.

​
Action table

actionPermissionTimeoutUse
addAdmin60sAdd numbers / JIDs
removeAdmin60sRemove members
promoteSuper-admin60sMake admin
demoteSuper-admin60sRemove admin
approveAdmin90sApprove pending request
rejectAdmin90sReject pending request

​
Notes

  • promote / demote require you to be super-admin (group creator or promoted by a super-admin).
  • approve / reject only work for groups with requireAdminApproval=true and have a longer timeout (90s) since they depend on responses from WhatsApp.
  • For approve/reject, prefer to pass the LID returned by /requests; if you only have the phone number, the service tries to resolve the equivalent LID automatically.

​
Errors

HTTPMessage
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" }
}