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

# Atualizar inbox

> Atualiza as configurações de um inbox existente (nome, webhook, agente padrão, configurações de API, etc.)



## OpenAPI

````yaml https://api.nuvia.ai/api/docs/user-json put /v1/inboxes/{id}
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentação da API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: auth
    description: Autenticação
paths:
  /v1/inboxes/{id}:
    put:
      tags:
        - inboxes
      summary: Atualizar inbox
      description: >-
        Atualiza as configurações de um inbox existente (nome, webhook, agente
        padrão, configurações de API, etc.)
      operationId: InboxController_updateInbox
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Identificador da empresa-alvo. Obrigatório apenas para API Keys
            globais (type=global). Ignorado para API Keys de empresa e usuários
            humanos.
          required: false
          schema:
            type: string
        - name: id
          required: true
          in: path
          description: ID do inbox
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInboxDto'
      responses:
        '200':
          description: Inbox atualizado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResponseDto'
        '400':
          description: Dados inválidos
        '401':
          description: Token inválido ou expirado
        '403':
          description: Sem permissão para acessar este recurso
        '404':
          description: Recurso não encontrado
      security:
        - JWT-auth: []
components:
  schemas:
    UpdateInboxDto:
      type: object
      properties:
        channel:
          type: string
          description: Canal do inbox
          enum:
            - WAP_AUTO_CLOSER
            - WEB_V2
            - EVOLUTION_API
            - LINKEDIN
            - EMAIL
        name:
          type: string
          minLength: 1
          description: Nome do inbox
        webhook_url:
          description: URL do webhook para notificações
          type: string
        number:
          type: string
          description: Número de telefone do inbox (formato internacional)
          minLength: 1
        default_agent:
          type: string
          description: ID do agente padrão para novas conversas
          minLength: 1
        api_wap_config:
          type: object
          description: Configurações da API do WhatsApp Business
          properties:
            phone_number_id:
              type: string
              description: ID do número de telefone no WhatsApp Business
            business_id:
              type: string
              description: ID do negócio no WhatsApp Business
            business_token:
              description: Token de autenticação do negócio
              type: string
              nullable: true
            waba_id:
              type: string
              description: ID da conta WhatsApp Business
          required:
            - phone_number_id
            - business_id
            - waba_id
        evolution_api_config:
          type: object
          description: Configurações da Evolution API
          properties:
            base_url:
              type: string
              minLength: 1
              description: URL base da Evolution API
            api_key:
              type: string
              minLength: 1
              description: Chave de API da Evolution
            instance_name:
              type: string
              minLength: 1
              description: Nome da instância na Evolution API
          required:
            - base_url
            - api_key
            - instance_name
        test_mode:
          type: object
          default:
            enabled: false
            test_numbers: []
          description: Configurações de modo de teste
          properties:
            enabled:
              description: Se o modo de teste está ativado
              type: boolean
            test_numbers:
              description: Números de telefone para teste
              type: array
              items:
                type: string
        general_config:
          type: object
          description: Configurações gerais do inbox
          properties:
            include_operator_name_on_message:
              type: boolean
              description: Se deve incluir o nome do operador nas mensagens
          required:
            - include_operator_name_on_message
        status:
          type: string
          description: Status do inbox
          enum:
            - ACTIVE
            - DELETED
        coexistence_enabled:
          description: Habilita ingestao de smb_message_echoes (WhatsApp Coexistence).
          type: boolean
        process_unsupported_messages:
          description: >-
            Permite que mensagens UNSUPPORTED da Meta sigam o fluxo normal do
            agent.
          type: boolean
    InboxResponseDto:
      type: object
      properties:
        _id:
          description: ID do inbox
          type: string
        name:
          type: string
          description: Nome do inbox
        number:
          type: string
          description: Número de telefone do inbox
        webhook_url:
          description: URL do webhook para notificações
          type: string
        test_mode:
          description: Configurações de modo de teste
          type: object
          properties:
            enabled:
              description: Se o modo de teste está ativado
              type: boolean
            test_numbers:
              description: Números de telefone para teste
              type: array
              items:
                type: string
          required:
            - enabled
            - test_numbers
        company:
          description: Empresa proprietária do inbox
        default_agent:
          description: Agente padrão para novas conversas
        channel:
          type: string
          description: Canal de comunicação (WAP_AUTO_CLOSER, etc)
        status:
          type: string
          enum:
            - ACTIVE
            - DELETED
          description: Status do inbox (ACTIVE, DELETED)
        api_wap_config:
          description: Configurações da API do WhatsApp Business (apenas para canal)
          type: object
          properties:
            phone_number_id:
              type: string
              description: ID do número de telefone no WhatsApp Business
            business_id:
              type: string
              description: ID do negócio no WhatsApp Business
            business_token:
              type: string
              description: Token de autenticação do negócio
            waba_id:
              type: string
              description: ID da conta WhatsApp Business
          required:
            - phone_number_id
            - business_id
            - business_token
            - waba_id
        evolution_api_config:
          description: Configurações da Evolution API
          type: object
          properties:
            base_url:
              type: string
              description: URL base da Evolution API
            api_key:
              type: string
              description: Chave de API da Evolution
            instance_name:
              type: string
              description: Nome da instância na Evolution API
          required:
            - base_url
            - api_key
            - instance_name
        linkedin_config:
          description: Configurações do LinkedIn (Unipile)
          type: object
          properties:
            account_id:
              type: string
              description: Account ID do LinkedIn na Unipile
            provider:
              description: Provider do LinkedIn (Unipile)
              type: string
            display_name:
              description: Nome exibido da conta
              type: string
            profile_url:
              description: URL do perfil LinkedIn
              type: string
            public_identifier:
              description: Identificador público do perfil LinkedIn
              type: string
          required:
            - account_id
        general_config:
          type: object
          description: Configurações gerais do inbox
          properties:
            include_operator_name_on_message:
              type: boolean
              description: Se deve incluir o nome do operador nas mensagens
          required:
            - include_operator_name_on_message
        coexistence_enabled:
          description: Habilita ingestao de smb_message_echoes (WhatsApp Coexistence).
          type: boolean
        process_unsupported_messages:
          description: >-
            Permite que mensagens UNSUPPORTED da Meta sigam o fluxo normal do
            agent.
          type: boolean
        createdAt:
          description: Data de criação do inbox
        updatedAt:
          description: Data de atualização do inbox
      required:
        - name
        - number
        - company
        - channel
        - status
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````