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

# Send group invite

> Send a link for someone to join the group.



## OpenAPI

````yaml /en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/invite
openapi: 3.0.3
info:
  title: Notifique API — WhatsApp
  description: >-
    Send WhatsApp messages and manage connections. Authenticate with
    `Authorization: Bearer sk_live_...` or `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfWaBearerAuth: []
  - ntfWaApiKeyHeader: []
tags:
  - name: Messages
    description: Send, list, edit, and cancel messages
  - name: Instances
    description: >-
      Register and manage connected WhatsApp numbers — each number is an
      **instance** (the phone that sends and receives messages).
  - name: Groups
    description: Groups (unofficial only)
paths:
  /v1/whatsapp/instances/{instanceId}/groups/invite:
    post:
      tags:
        - Grupos
      summary: Send group invite
      description: Send a link for someone to join the group.
      operationId: ntfWa_postV1WhatsappInstancesInstanceIdGroupsInvite
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfWa_GroupInviteSendRequest'
            examples:
              single:
                summary: Um grupo
                value:
                  groups:
                    - 120363295648424210@g.us
                  to:
                    - '5511999999999'
                  description: Convite para o grupo
              multiple:
                summary: Vários grupos
                value:
                  groups:
                    - 120363295648424210@g.us
                    - 120363295648424211@g.us
                  to:
                    - '5511999999999'
                  description: Links dos grupos
      responses:
        '200':
          description: >-
            data.results: um item por grupo. Sucesso: groupJid, success: true,
            data.send, data.inviteUrl. Falha: groupJid, success: false, error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            groupJid:
                              type: string
                            success:
                              type: boolean
                            data:
                              type: object
                              properties:
                                send:
                                  type: boolean
                                inviteUrl:
                                  type: string
                            error:
                              type: string
              example:
                success: true
                data:
                  results:
                    - groupJid: 120363130091228687@g.us
                      success: true
                      data:
                        send: true
                        inviteUrl: https://chat.whatsapp.com/EYkW0HWQLJ7CS82xdLIu4i
                    - groupJid: 120363048720182344@g.us
                      success: true
                      data:
                        send: true
                        inviteUrl: https://chat.whatsapp.com/Gst4H0uNCjMFEwddWjWpm9
        '400':
          description: groups (ou groupJid) e to ausentes ou inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '402':
          description: Plano expirado ou suspenso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '403':
          description: Recursos de grupos desativados ou escopo ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '404':
          description: Instance not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '502':
          description: Erro ao processar requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
components:
  schemas:
    NtfWa_GroupInviteSendRequest:
      type: object
      required:
        - to
      properties:
        groups:
          type: array
          items:
            type: string
            pattern: ^\d+@g\.us$
          minItems: 1
          maxItems: 100
          description: JIDs dos grupos cujo link será enviado. Um ou mais.
        groupJid:
          type: string
          description: Deprecated. Use groups. JID de um único grupo.
        to:
          type: array
          items:
            type: string
          minItems: 1
          description: 'Números com DDI que receberão os links (ex.: 5511999999999)'
        description:
          type: string
          description: Text enviado com o convite (optional)
    NtfWa_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Message legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Responses de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        note:
          type: string
      required:
        - success
        - error
        - message
        - code
  securitySchemes:
    ntfWaBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfWaApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key no header x-api-key.

````