Skip to main content

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 on every route. Each call validates the instance ownership. This section covers all /api/group/* routes: creation, listing, details, participant management, metadata updates, invite link reset, joining, and leaving. For communities (parent groups), see Communities.

​
Endpoints

MethodPathFunction
POST/api/group/create/:instanceCreate group
GET/api/group/list/:instanceList groups
GET/api/group/info/:instanceGroup details
PUT/api/group/update/:instanceUpdate name / description / picture / permissions
POST/api/group/participants/:instanceAdd / remove / promote / demote / approve / reject
POST/api/group/join/:instanceJoin via code / link
POST/api/group/resetLink/:instanceRevoke and regenerate invite link
GET/api/group/requests/:instanceList pending requests
DELETE/api/group/leave/:instanceLeave group

​
Accepted identifiers

Most endpoints accept an identifier field, which can be:
FormExample
Group JID120363406289005073@g.us
Invite codeABC123XYZ
Full linkhttps://chat.whatsapp.com/ABC123XYZ
Exceptions:
  • POST /api/group/join accepts only a code or link (no JID).
  • GET /api/community/listSubGroups requires a JID in the query ?communityJid=.

​
Data structures

​
GroupInfo

Standard response for the create and update routes. 
{
  "name": "Dev Team",
  "jid": "120363406289005073@g.us",
  "description": "Technical discussions",
  "inviteCode": "ABC123XYZ",
  "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
  "createdBy": "5511999999999@s.whatsapp.net",
  "participantCount": 3,
  "participants": [
    { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
  ],
  "groupSettings": {
    "membersCanEditInfo": true,
    "membersCanSendMessages": true,
    "membersCanAddOthers": false,
    "requireAdminApproval": false
  },
  "isCommunity": false,
  "isParent": false,
  "linkedParentJid": null
}

​
GroupDetail

Response from GET /info. Includes extra fields beyond GroupInfo: image, createdAt, metadata (author of the last name / description change), isEphemeral, isIncognito, isSuspended, isDefaultSubGroup.

​
GroupPermissions

FieldTypeWhatsApp meaning
membersCanEditInfoboolInverse of IsLocked
membersCanSendMessagesboolInverse of IsAnnounce
membersCanAddOthersboolMemberAddMode == AllMember
requireAdminApprovalboolIsJoinApprovalRequired

​
Error envelope

All routes use the API’s standard envelope: 
{
  "success": false,
  "error": { "message": "Identifier is required" }
}

​
Error reference (summary)

CategoryMessage
AuthNot authorized to view group requests (must be admin)
AuthNot authorized to perform this action (must be admin)
AuthNot authorized to update this group (must be admin)
AuthNot authorized to reset group invite link (must be admin)
AuthNot allowed to join this group
AuthNot allowed to leave this group
ValidationIdentifier is required
ValidationAt least one participant is required
ValidationInvalid action. Must be one of: add, remove, promote, demote, approve, reject
Identifierfailed to resolve group from identifier (not a valid JID, code, or link)
Identifierinvalid group JID <jid>: <reason>
Identifiernot a group JID
StateInstance is not connected to WhatsApp
StateGroup not found or you are not a member of this group
InviteInvite link has been revoked or expired
InviteInvalid invite link or code
Throttlerate limit exceeded (429): wait before creating again

​
Next

Create group

Create a new group with initial participants.

List groups

Return all groups for the instance.