Join Group

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

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

fetch('https://api.example.com/api/group/join/: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/join/:instance"

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

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

print(response.text)

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

By link

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

await fetch(`https://ryzeapi.cloud/api/group/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "https://chat.whatsapp.com/ABC123XYZ"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "https://chat.whatsapp.com/ABC123XYZ"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "identifier": "https://chat.whatsapp.com/ABC123XYZ"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

await fetch(`https://ryzeapi.cloud/api/group/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "ABC123XYZ"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "ABC123XYZ"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "identifier": "ABC123XYZ"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

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

HTTP	Message
400	`Invalid invite link or code`
400	`Invite link has been revoked or expired`
403	`Not allowed to join this group`
404	`Group not found`

Envelope:

{
  "success": false,
  "error": { "message": "Invite link has been revoked or expired" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

By link

By code

Success response

Path parameters

Headers

Request body

Notes

Errors

​Description

​Examples

​By link

​By code

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

Description

Examples

By link

By code

Success response

Path parameters

Headers

Request body

Notes

Errors