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

# Check campaign launch readiness

> Returns a checklist (`can_start`, `blockers`, `member_count`) so clients can
verify a campaign is ready before calling `POST .../start`.




## OpenAPI

````yaml /api-reference/campaigns-contacts.openapi.yaml get /api/v1/campaigns/{campaign_id}/readiness
openapi: 3.1.0
info:
  title: Campaigns & Contacts API
  description: >
    REST endpoints for managing calling campaigns (batches) and contact
    directories (People Groups, columns, and rows).


    **Production base URL:** `https://api.kupe.in` — prepend this to each path
    below.


    ## Recommended workflow: Excel → People → Campaign → Launch


    1. `POST /api/v1/people-groups` — create a people list

    2. `POST /api/v1/people-groups/{id}/upload/preview` — (optional) validate
    Excel/CSV mapping

    3. `POST /api/v1/people-groups/{id}/upload` — import contacts from `.csv`,
    `.xlsx`, or `.xls`

    4. `POST /api/v1/campaigns` — create a campaign (agent/workflow + caller
    phone)

    5. `POST /api/v1/campaigns/{id}/groups` — attach the people list to the
    campaign

    6. `GET /api/v1/campaigns/{id}/readiness` — verify the campaign can be
    launched

    7. `POST /api/v1/campaigns/{id}/start` — start dialing
  version: 1.0.0
servers:
  - url: https://api.kupe.in
    description: Production
security:
  - KupeApiKey: []
  - BearerAuth: []
tags:
  - name: Campaigns
    description: Create, update, control, list, and monitor outbound campaigns (batches).
  - name: People Groups
    description: >-
      Define schemas (columns), list records (rows), and upload contact files
      (CSV, Excel).
paths:
  /api/v1/campaigns/{campaign_id}/readiness:
    get:
      tags:
        - Campaigns
      summary: Check campaign launch readiness
      description: >
        Returns a checklist (`can_start`, `blockers`, `member_count`) so clients
        can

        verify a campaign is ready before calling `POST .../start`.
      operationId: getCampaignReadiness
      parameters:
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Readiness checklist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignReadinessResponse'
components:
  schemas:
    CampaignReadinessResponse:
      type: object
      properties:
        can_start:
          type: boolean
        member_count:
          type: integer
        has_agent_or_workflow:
          type: boolean
        has_caller_phone:
          type: boolean
        status:
          type: string
        blockers:
          type: array
          items:
            type: string
  securitySchemes:
    KupeApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Kupe dashboard API key.
      x-default: YOUR_KUPE_API_KEY
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase session JWT.

````