Skip to main content
POST
/
api
/
group
/
join
/
:instance
Join Group
curl --request POST \
  --url https://api.example.com/api/group/join/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "identifier": "<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: partial (repeated calls on an open group return the same groupJid)

​
Description

Joins a group from an invite code (ABC123XYZ) or full link (https://chat.whatsapp.com/ABC123XYZ). If the group has requireAdminApproval=true, the join is queued and returns requiresApproval: true.
Unlike the other routes, /join does not accept a JID as the identifier, only a code or link.

​
Examples

Joins the group by passing the full link (https://chat.whatsapp.com/ABC123XYZ) in identifier. The service extracts the code automatically and attempts the join. 
curl -X POST "https://ryzeapi.cloud/api/group/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "https://chat.whatsapp.com/ABC123XYZ"
  }'

​
By code

Joins the group by passing only the raw code (ABC123XYZ) in identifier. Useful when you already extracted the code from the link in another flow. 
curl -X POST "https://ryzeapi.cloud/api/group/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "ABC123XYZ"
  }'

​
Success response

The groupJid identifies the group the instance has joined (or attempted to join). When requiresApproval: true, the join has not yet taken effect, it is awaiting manual approval from an admin; check the pending queue with /requests. When false, the instance is already a member and can send/receive messages.
200 OK
{
  "success": true,
  "message": "Successfully joined the group",
  "groupJid": "120363406289005073@g.us",
  "requiresApproval": false
}
200 OK (with manual approval)
{
  "success": true,
  "message": "Join request sent successfully. Waiting for admin approval.",
  "groupJid": "120363406289005073@g.us",
  "requiresApproval": true
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

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

​
Request body

​
identifier
string
required
Invite code (ABC123XYZ) or full link (https://chat.whatsapp.com/ABC123XYZ).

​
Notes

  • requiresApproval: true means you have not yet joined, your request is in the queue listed by /requests until an admin approves it.
  • When the link has been revoked by an admin (via /resetLink), the old code stops working immediately.
  • To preview the group without joining, use GET /info with the link as the identifier.

​
Errors

HTTPMessage
400Invalid invite link or code
400Invite link has been revoked or expired
403Not allowed to join this group
404Group not found
Envelope: 
{
  "success": false,
  "error": { "message": "Invite link has been revoked or expired" }
}