> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wappfy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Join a group via invite code

> Joins a group using an invite code or link.



## OpenAPI

````yaml openapi.json post /api/instances/{instanceId}/groups/join
openapi: 3.0.0
info:
  title: Wappfy API
  description: >-
    WhatsApp API Platform — Manage instances, send messages, and build
    integrations.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wappfy.io
    description: Production
security: []
tags:
  - name: Instances
    description: Create, connect, and manage WhatsApp instances (WAHA or Cloud API)
  - name: Messages
    description: >-
      Send messages via WhatsApp (text, media, location, poll, contacts, and
      more)
  - name: Chats
    description: List chats, read messages, mark as seen, and manage typing indicators
  - name: Groups
    description: Create and manage WhatsApp groups, participants, and invite links
  - name: Contacts
    description: Look up contacts, check phone numbers, and fetch profile pictures
  - name: Labels
    description: Organize chats with WhatsApp Business labels
  - name: Channels
    description: Create and manage WhatsApp Channels (newsletters)
  - name: Status
    description: Publish text status/stories
  - name: Presence
    description: Set and get online/offline presence
  - name: Webhooks
    description: Configure webhook endpoints to receive real-time event notifications
  - name: Admin
    description: >-
      Platform administration — user management, statistics, and proxy
      monitoring (admin only)
paths:
  /api/instances/{instanceId}/groups/join:
    post:
      tags:
        - Groups
      summary: Join a group via invite code
      description: Joins a group using an invite code or link.
      operationId: GroupsController_joinGroup
      parameters:
        - name: instanceId
          required: true
          in: path
          description: The WhatsApp instance UUID
          schema:
            format: uuid
            example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JoinGroupDto'
      responses:
        '200':
          description: Joined the group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupInfoResponseDto'
        '401':
          description: Missing or invalid authentication token
        '403':
          description: Insufficient permissions
        '500':
          description: Internal server error
      security:
        - bearer: []
components:
  schemas:
    JoinGroupDto:
      type: object
      properties:
        code:
          type: string
          description: Group invite code or full invite link
      required:
        - code
    GroupInfoResponseDto:
      type: object
      properties:
        id:
          type: string
          example: 120363XXX@g.us
          description: Group JID
        subject:
          type: string
          example: Team Chat
          description: Group subject/title
        description:
          type: string
          description: Group description text
        participants:
          description: Group members
          type: array
          items:
            $ref: '#/components/schemas/ParticipantResponseDto'
        creation:
          type: number
          example: 1707350400
          description: Creation timestamp
        pictureUrl:
          type: string
          description: Group picture URL
      required:
        - id
        - subject
        - participants
        - creation
    ParticipantResponseDto:
      type: object
      properties:
        id:
          type: string
          example: 5511999999999@c.us
          description: Participant WhatsApp ID
        admin:
          type: string
          enum:
            - admin
            - superadmin
            - null
          description: Admin role (null = regular member)
      required:
        - id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````