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

# Estimate WhatsApp campaign

> How many people a campaign would reach, what it costs, and whether your wallet covers it. Sends nothing.

Scope: `whatsapp:send`.



## OpenAPI

````yaml /openapi.json post /whatsapp/campaigns/estimate
openapi: 3.1.0
info:
  title: Messaly API
  version: 1.0.0
  description: >-
    SMS, WhatsApp, email, contacts and CRM for your business. Amounts are in
    KES. Authenticate with an API key (Settings → API keys). A key can be
    limited to scopes and to IP addresses; a key with no scopes can call every
    endpoint here.
servers:
  - url: https://app.telaven.com/api/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
    description: Wallet balance and SMS pricing.
  - name: SMS
    description: Send SMS and read messages and analytics.
  - name: SMS campaigns
    description: Create, schedule and send SMS campaigns to lists and tags.
  - name: Contacts
    description: Contacts and contact lists.
  - name: WhatsApp
    description: Send approved WhatsApp templates.
  - name: Email
    description: Email campaigns and unsubscribes.
  - name: CRM
    description: Deals, companies and pipelines.
paths:
  /whatsapp/campaigns/estimate:
    post:
      tags:
        - WhatsApp
      summary: Estimate WhatsApp campaign
      description: >-
        How many people a campaign would reach, what it costs, and whether your
        wallet covers it. Sends nothing.


        Scope: `whatsapp:send`.
      operationId: estimateWhatsappCampaign
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                templateId:
                  type: string
                  format: uuid
                  description: The template you'll send.
                contactListIds:
                  type: array
                  items:
                    type: string
                  description: Contact lists to send to.
                tags:
                  type: array
                  items:
                    type: string
                  description: Contacts with any of these tags.
                uploadPhones:
                  type: array
                  items:
                    type: string
                  description: Or the phone numbers from your own sheet.
              required:
                - templateId
            example:
              templateId: 7d2c…
              contactListIds:
                - 9a0b…
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                recipients: 1187
                optedOut: 13
                invalid: 0
                category: marketing
                rateCents: 150
                totalCents: 178050
                balanceCents: 1443750
                enough: true
        '401':
          description: No API key, or the key is wrong, disabled or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key doesn't have the scope this endpoint needs, or it's used
            from an address its IP allowlist doesn't include.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            More than 120 requests in a minute with this key. Wait for the
            number of seconds in Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Something went wrong on our side. Retry with backoff. A POST sent
            with an Idempotency-Key replays this same error for that key,
            because the request may have partly run: check the result before
            trying again with a new key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable code where one exists, e.g. INSUFFICIENT_BALANCE.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer tlv_…'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.