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

# Connect a WhatsApp account

> Connect a WhatsApp Business account to the workspace. Two integration types are supported:

- **`whatsapp`** (Meta Cloud API): requires a WABA ID, access token, and phone number.
- **`whatsapp-no-api`** (Evolution API): requires an Evolution API instance and credentials.



## OpenAPI

````yaml /openapi.json post /public/v1/accounts
openapi: 3.0.0
info:
  title: Hostreach API
  description: >-
    Public REST API for Hostreach.


    Authenticate with an API key via the `X-Api-Key` header or `Authorization:
    Bearer <key>` header.


    Generate API keys from **Settings › Workspace › Acceso API** in the
    dashboard.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.hostreach.io/v1
    description: Production
  - url: http://localhost:3001/v1
    description: Local
security:
  - apiKey: []
tags:
  - name: Identity
    description: Current workspace and usage
  - name: Platforms
    description: Supported real-estate portals and filter schemas
  - name: Extractions
    description: Lead extraction jobs
  - name: Leads
    description: Lead management
  - name: Campaigns
    description: Campaign management
  - name: Messaging
    description: Inbox and WhatsApp conversations
  - name: Templates
    description: WhatsApp message templates
  - name: Accounts
    description: WhatsApp accounts
  - name: Valuations
    description: Property valuations
  - name: Fichas
    description: Property listing sheets
  - name: Scheduling
    description: Calendar and appointments
  - name: Webhooks
    description: Event subscriptions
paths:
  /public/v1/accounts:
    post:
      tags:
        - Accounts
      summary: Connect a WhatsApp account
      description: >-
        Connect a WhatsApp Business account to the workspace. Two integration
        types are supported:


        - **`whatsapp`** (Meta Cloud API): requires a WABA ID, access token, and
        phone number.

        - **`whatsapp-no-api`** (Evolution API): requires an Evolution API
        instance and credentials.
      operationId: PublicAccountsController_createAccount
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: Meta Cloud API (whatsapp)
                  type: object
                  required:
                    - type
                    - whatsAppBusinessAccountId
                    - token
                    - phone
                  properties:
                    type:
                      type: string
                      enum:
                        - whatsapp
                      description: Integration type.
                    whatsAppBusinessAccountId:
                      type: string
                      description: WhatsApp Business Account ID from Meta Business Manager.
                      example: '123456789012345'
                    token:
                      type: string
                      description: >-
                        Permanent access token for the WhatsApp Business
                        Account.
                    phone:
                      type: string
                      description: Phone number in E.164 format.
                      example: '+34600000000'
                - title: Evolution API (whatsapp-no-api)
                  type: object
                  required:
                    - type
                    - phone
                    - evolutionInstanceId
                    - evolutionApiUrl
                    - evolutionApiKey
                  properties:
                    type:
                      type: string
                      enum:
                        - whatsapp-no-api
                      description: Integration type.
                    phone:
                      type: string
                      description: Phone number in E.164 format.
                      example: '+34600000000'
                    evolutionInstanceId:
                      type: string
                      description: Instance ID in your Evolution API server.
                    evolutionApiUrl:
                      type: string
                      format: uri
                      description: Base URL of your Evolution API server.
                      example: https://evo.example.com
                    evolutionApiKey:
                      type: string
                      description: Global or instance-level API key for Evolution API.
                    evolutionInstanceName:
                      type: string
                      description: >-
                        Human-readable name for the Evolution API instance
                        (optional).
      responses:
        '201':
          description: ''
      security:
        - bearerApiKey: []
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API key (hr_live_... or hr_test_...). Generate from Settings › Workspace
        › Acceso API.

````