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

# Link de convite

> Retorna o link de convite do grupo. Envie `reset: true` para revogar o link anterior e gerar um novo.



## OpenAPI

````yaml /pt-br/api-reference/openapi.json post /groups/invite-link
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    API de WhatsApp multi-tenant. Envie mensagens e gerencie webhooks por uma
    superfície única.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /groups/invite-link:
    post:
      tags:
        - Grupos
      summary: Link de convite
      description: >-
        Retorna o link de convite do grupo. Envie `reset: true` para revogar o
        link anterior e gerar um novo.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupInviteLinkBody'
      responses:
        '200':
          $ref: '#/components/responses/InviteLinkResult'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  schemas:
    GroupInviteLinkBody:
      type: object
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/GroupId'
          description: id do grupo (devolvido por GET /groups).
        reset:
          type: boolean
          description: Revoga o link anterior e gera um novo.
          default: false
    GroupId:
      type: string
      description: id do grupo (devolvido por GET /groups).
      example: '120363012345678901'
  responses:
    InviteLinkResult:
      description: Link de convite do grupo.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                properties:
                  inviteLink:
                    type: string
                    example: https://chat.whatsapp.com/ABC123
    Error:
      description: Erro.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Token de conta (`zpfy_acct_...`) — gerencia instâncias e webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Token de instância (`zpfy_inst_...`) — envia mensagens.

````