> ## 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. # Criar inbox > Cria um novo inbox (canal de atendimento) para receber e enviar mensagens. Suporta múltiplos canais: WhatsApp Business API, Evolution API, etc. ## OpenAPI ````yaml https://api.nuvia.ai/api/docs/user-json post /v1/inboxes 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: messages x-group: Mensagens - name: contacts x-group: Contatos - name: campaigns x-group: Campanhas - name: tables x-group: Tabelas e Listas - name: agents x-group: Agentes - name: conversations x-group: Conversas - name: inboxes x-group: Caixas de Entrada - name: knowledge x-group: Base de Conhecimento - name: Webhooks x-group: Webhooks - name: campaign-enrollments x-group: Inscrições em Campanha - name: custom-fields x-group: Campos Customizados - name: resources x-group: Arquivos e Anexos paths: /v1/inboxes: post: tags: - inboxes summary: Criar inbox description: >- Cria um novo inbox (canal de atendimento) para receber e enviar mensagens. Suporta múltiplos canais: WhatsApp Business API, Evolution API, etc. operationId: InboxController_createInbox 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 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateInboxDto' responses: '201': description: Inbox criado 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 security: - JWT-auth: [] components: schemas: CreateInboxDto: type: object properties: name: type: string minLength: 1 description: Nome do inbox webhook_url: type: string description: URL do webhook para notificações minLength: 1 number: type: string description: Número de telefone do inbox (formato internacional) pattern: ^\+.* default_agent: type: string description: ID do agente padrão para novas conversas channel: type: string description: Canal de comunicação (WAP_AUTO_CLOSER, etc) enum: - WAP_AUTO_CLOSER - WEB_V2 - EVOLUTION_API - LINKEDIN - EMAIL - WEBCHAT api_wap_config: type: object description: Configurações da API do WhatsApp Business properties: phone_number_id: type: string minLength: 1 description: ID do número de telefone no WhatsApp Business business_id: type: string minLength: 1 description: ID do negócio no WhatsApp Business business_token: type: string minLength: 1 description: Token de autenticação do negócio waba_id: type: string minLength: 1 description: ID da conta WhatsApp Business required: - phone_number_id - business_id - business_token - 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 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 coexistence_enabled: description: >- Campo somente leitura, sincronizado automaticamente a partir da Meta. not: {} process_unsupported_messages: type: boolean description: >- Permite que mensagens UNSUPPORTED da Meta sigam o fluxo normal do agent em vez de serem puladas. Default false. disable_inbound_ai: type: boolean description: >- Opt-in. Quando true, a IA não atende inbound orgânico: novas conversas nascem para atendimento humano. A IA segue atendendo leads de campanha. Default false. pdf_local_text_extraction: type: boolean description: >- Opt-in do modo híbrido de leitura de PDF. Quando true, o texto é extraído localmente e a IA recebe o TEXTO em vez da imagem (ela segue no circuito, só reorganiza): sem limite de tamanho e sem tokens de visão. Cai de volta no caminho de visão quando a leitura local não serve (PDF escaneado, não-PDF, ilegível). Default false. default_owner: description: >- Opt-in. ID do usuário dono padrão de qualquer conversa nova deste inbox (dono explícito do caller tem precedência). Null/ausente = sem dono padrão. type: string nullable: true webchat_config: type: object description: >- Config editável do canal WEBCHAT — site_key/hmac_secret são gerados pelo servidor properties: allowed_domains: description: Onde o widget pode carregar; fora da lista, é bloqueado maxItems: 20 type: array items: type: string minLength: 1 allow_mobile_webview: description: 'WebView mobile chega com Origin null/file: — opt-in' type: boolean paused: description: 'Pausado: o widget para de carregar, a configuração fica' type: boolean identity_mode: description: 'ADR-27: off = opcional; monitor = migração; enforced = exige' type: string enum: - 'off' - monitor - enforced privacy_notice: description: 'Aviso de privacidade: texto + link, mostrado pelo widget' type: object properties: enabled: type: boolean message: type: string maxLength: 240 link_url: anyOf: - type: string maxLength: 500 format: uri - type: string enum: - '' additionalProperties: false prechat: description: 'Pré-chat: dados pedidos antes da primeira mensagem' type: object properties: enabled: type: boolean title: type: string maxLength: 80 helper_text: type: string maxLength: 120 fields: maxItems: 20 type: array items: type: object properties: id: anyOf: - type: string enum: - name - email - phone - type: string enum: - linkedin_identifier - job_title - department - seniority - experience - skills - country - region - city - type: string pattern: ^[0-9a-f]{24}$ enabled: type: boolean placeholder: type: string maxLength: 80 required: type: boolean label: type: string maxLength: 60 field_type: type: string enum: - text - date - number - select - multi_select - email - phone - url required: - id additionalProperties: false additionalProperties: false proactive_enabled: type: boolean triggers: description: Gatilhos proativos editados pela aba Comportamento maxItems: 20 type: array items: type: object properties: id: type: string minLength: 1 maxLength: 64 message: type: string minLength: 1 maxLength: 90 enabled: type: boolean display: type: string enum: - notification - preview - panel rules: maxItems: 10 type: array items: type: object properties: attribute: type: string enum: - page_url - time_on_page - number_of_visits operator: type: string enum: - contains - equals - matches - gte value: anyOf: - type: string maxLength: 200 - type: number join: type: string enum: - AND - OR required: - attribute - operator - value additionalProperties: false required: - id - message additionalProperties: false attachments: description: 'Anexos do visitante: chave geral + tipos permitidos' type: object properties: enabled: type: boolean media: type: boolean documents: type: boolean audio: type: boolean additionalProperties: false cta: description: 'Chamadas à ação da tela de Entrada: botões com link' type: object properties: enabled: type: boolean items: maxItems: 5 type: array items: type: object properties: id: type: string minLength: 1 maxLength: 64 label: type: string minLength: 1 maxLength: 40 url: type: string maxLength: 500 pattern: ^https?:\/\/\S+$ icon: type: string enum: - phone - whatsapp - email - globe - link - none required: - id - label - url additionalProperties: false additionalProperties: false away_after_seconds: description: 'Configurações avançadas: visitante "ausente" após N segundos' type: integer minimum: 30 maximum: 3600 appearance: description: Aparência do widget — nada aqui é segredo type: object properties: display_name: type: string maxLength: 60 subtitle: type: string maxLength: 80 welcome_title: type: string maxLength: 80 welcome_description: type: string maxLength: 240 welcome_message: type: string maxLength: 500 brand_color: type: string pattern: ^#[0-9a-fA-F]{6}$ position: type: string enum: - left - right color_scheme: type: string enum: - system - light - dark font_family: type: string enum: - system - arial - verdana - trebuchet - times - montserrat - playfair - roboto-mono - jetbrains-mono button_icon: type: string enum: - chat - chat-dots - headset - question - message button_size: type: string enum: - small - medium - large button_spacing_x: type: integer minimum: 0 maximum: 120 button_spacing_y: type: integer minimum: 0 maximum: 120 locale: type: string maxLength: 10 reply_time: type: string enum: - in_a_few_minutes - in_a_few_hours - in_a_day additionalProperties: false additionalProperties: false required: - name 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 disable_inbound_ai: description: >- Opt-in. Quando true, a IA não atende inbound orgânico (novas conversas para atendimento humano); a IA segue atendendo leads de campanha. type: boolean pdf_local_text_extraction: type: boolean description: >- Opt-in do modo híbrido de leitura de PDF. Quando true, o texto é extraído localmente e a IA recebe o TEXTO em vez da imagem (ela segue no circuito, só reorganiza): sem limite de tamanho e sem tokens de visão. Cai de volta no caminho de visão quando a leitura local não serve (PDF escaneado, não-PDF, ilegível). Default false. default_owner: description: >- ID do usuário dono padrão das conversas novas deste inbox (opt-in). Null = sem dono padrão. type: string nullable: true 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.