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

# Criar uma nova instância

> Cria uma nova instância WhatsApp (WAHA ou Cloud API). Uma sessão WAHA é provisionada automaticamente. Retorna 403 se o limite do plano do usuário for atingido.



## OpenAPI

````yaml openapi-pt-BR.json post /api/instances
openapi: 3.0.0
info:
  title: Wappfy API
  description: >-
    WhatsApp API Platform — Manage instances, send messages, and build
    integrations.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wappfy.io
    description: Production
security: []
tags:
  - name: Instâncias
    description: Criar, conectar e gerenciar instâncias WhatsApp (WAHA ou Cloud API)
  - name: Mensagens
    description: >-
      Enviar mensagens via WhatsApp (texto, mídia, localização, enquete,
      contatos e mais)
  - name: Conversas
    description: >-
      Listar conversas, ler mensagens, marcar como vistas e gerenciar
      indicadores de digitação
  - name: Grupos
    description: Criar e gerenciar grupos WhatsApp, participantes e links de convite
  - name: Contatos
    description: Buscar contatos, verificar números de telefone e obter fotos de perfil
  - name: Etiquetas
    description: Organizar conversas com etiquetas do WhatsApp Business
  - name: Canais
    description: Criar e gerenciar Canais WhatsApp (newsletters)
  - name: Status
    description: Publicar status/stories de texto
  - name: Presença
    description: Definir e obter presença online/offline
  - name: Webhooks
    description: >-
      Configurar endpoints de webhook para receber notificações de eventos em
      tempo real
  - name: Administração
    description: >-
      Administração da plataforma — gerenciamento de usuários, estatísticas e
      monitoramento de proxy (apenas admin)
paths:
  /api/instances:
    post:
      tags:
        - Instâncias
      summary: Criar uma nova instância
      description: >-
        Cria uma nova instância WhatsApp (WAHA ou Cloud API). Uma sessão WAHA é
        provisionada automaticamente. Retorna 403 se o limite do plano do
        usuário for atingido.
      operationId: InstancesController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstanceDto'
      responses:
        '201':
          description: Instância criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceResponseDto'
        '401':
          description: Token de autenticação ausente ou inválido
        '403':
          description: Limite do plano atingido
        '500':
          description: Erro interno do servidor
      security:
        - bearer: []
components:
  schemas:
    CreateInstanceDto:
      type: object
      properties:
        name:
          type: string
          description: Nome de exibição opcional para a instância
        instance_type:
          type: string
          enum:
            - waha
            - cloud_api
        phone_number:
          type: string
          description: 'Número de telefone em formato internacional (ex: +5511999999999)'
          example: '+5511999999999'
        cloud_phone_number_id:
          type: string
          description: ID do Número de Telefone da Cloud API (do Meta Business)
          example: '1234567890'
        cloud_waba_id:
          type: string
          description: ID da Conta WhatsApp Business da Cloud API
          example: '9876543210'
        cloud_access_token:
          type: string
          description: Token de acesso permanente da Cloud API do Meta
      required:
        - instance_type
    InstanceResponseDto:
      type: object
      properties:
        id:
          type: string
        user_id:
          type: string
        name:
          type: string
        instance_type:
          type: string
          enum:
            - waha
            - cloud_api
        status:
          type: string
          enum:
            - created
            - starting
            - scan_qr
            - connected
            - disconnected
            - failed
        phone_number:
          type: string
        display_name:
          type: string
          description: Nome de exibição do WhatsApp (pushName)
        session_name:
          type: string
        phone_number_id:
          type: string
        waba_id:
          type: string
        access_token:
          type: string
        webhook_url:
          type: string
        profile_picture_url:
          type: string
        is_active:
          type: boolean
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - user_id
        - name
        - instance_type
        - status
        - is_active
        - created_at
        - updated_at
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````