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

# Permissão para grupos

> Define quem pode adicionar o número em grupos.

Define quem pode adicionar o número em grupos.

<Note>Aliases consolidados da collection: `Permissão para adicionar em grupos`.</Note>


## OpenAPI

````yaml POST /instances/{instanceId}/token/{instanceToken}/privacy/group-add
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances/{instanceId}/token/{instanceToken}/privacy/group-add:
    post:
      tags:
        - Privacidade
      summary: Permissão para grupos
      description: Define quem pode adicionar o número em grupos.
      operationId: privacy_group-add
      parameters:
        - name: instanceId
          in: path
          required: true
          description: Identificador único da instância.
          schema:
            type: string
            example: abc1234567890
        - name: instanceToken
          in: path
          required: true
          description: Token privado da instância retornado na criação.
          schema:
            type: string
            example: tok_a1b2c3d4e5f6
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  example: CONTACT_BLACKLIST
                contactsBlacklist:
                  type: array
                  items:
                    type: object
                    properties:
                      action:
                        type: string
                        example: add
                      phone:
                        type: string
                        example: '{{PHONE}}'
                    required:
                      - action
                      - phone
                    example:
                      action: add
                      phone: '{{PHONE}}'
                  example:
                    - action: add
                      phone: '{{PHONE}}'
                    - action: remove
                      phone: '{{PHONE}}'
              required:
                - type
                - contactsBlacklist
              example:
                type: CONTACT_BLACKLIST
                contactsBlacklist:
                  - action: add
                    phone: '{{PHONE}}'
                  - action: remove
                    phone: '{{PHONE}}'
            examples:
              permissao-para-adicionar-em-grupos:
                summary: Permissão para adicionar em grupos
                value:
                  type: CONTACT_BLACKLIST
                  contactsBlacklist:
                    - action: add
                      phone: '{{PHONE}}'
                    - action: remove
                      phone: '{{PHONE}}'
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                required:
                  - success
                example:
                  success: true
              example:
                success: true
        '401':
          description: Client-Token ou instanceToken inválido
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Invalid instanceToken
        '404':
          description: Instância ou recurso não encontrado
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Instance not found
        '408':
          description: Timeout do worker
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Worker command timeout
        '422':
          description: Falha ao processar a ação
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unable to process request
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````