Skip to main content
POST
/
group
/
join
Join a group using an invite code
curl --request POST \
  --url https://api.wppfy.com/group/join \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "inviteCode": "https://chat.whatsapp.com/IYnl5Zg9bUcJD32rJrDzO7"
}
'
{
  "response": "Group join successful",
  "group": {
    "JID": "jid8@g.us",
    "OwnerJID": "1232@s.whatsapp.net",
    "Name": "Grupo de Suporte",
    "NameSetAt": "2023-11-07T05:31:56Z",
    "NameSetBy": "<string>",
    "Topic": "<string>",
    "IsLocked": true,
    "IsAnnounce": true,
    "AnnounceVersionID": "<string>",
    "IsEphemeral": true,
    "DisappearingTimer": 1,
    "IsIncognito": true,
    "IsParent": true,
    "IsJoinApprovalRequired": true,
    "LinkedParentJID": "<string>",
    "IsDefaultSubGroup": true,
    "GroupCreated": "2023-11-07T05:31:56Z",
    "ParticipantVersionID": "<string>",
    "Participants": [
      "<unknown>"
    ],
    "MemberAddMode": "admin_add",
    "OwnerCanSendMessage": true,
    "OwnerIsAdmin": true,
    "DefaultSubGroupId": "<string>",
    "invite_link": "<string>",
    "request_participants": "<string>"
  }
}

Authorizations

token
string
header
required

Body

application/json
inviteCode
string
required

Invite code or full group URL. Accepted formats:

Required string length: 10 - 50
Example:

"https://chat.whatsapp.com/IYnl5Zg9bUcJD32rJrDzO7"

Response

Successfully joined the group

response
string
Example:

"Group join successful"

group
object

Representa um grupo/conversa coletiva