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

# Create campaign

> Crea una campaña en el **Bot Manager**.

Todas las campañas se crean en estado **PAUSED**; luego, al cargar casos con el endpoint correspondiente, la campaña se actualiza automáticamente a **ONGOING**.

Para una performance óptima se recomienda configurar ventana horaria y límites.



## OpenAPI

````yaml POST /api/v2/create_campaign/
openapi: 3.0.0
info:
  title: API Inceptia
  description: API para la consulta de campañas, casos y llamadas de un bot.
  version: 2.0.0
servers:
  - url: https://admintest.inceptia.ai/
    description: Ambiente de pruebas
  - url: https://admin.inceptia.ai/
    description: Ambiente productivo
security: []
tags:
  - name: Autenticación
    description: Endpoints para la autenticación de usuarios y gestión de tokens.
  - name: Bots
    description: Endpoints para operaciones relacionadas con los bots.
  - name: Campañas
    description: Endpoints para operaciones relacionadas con las campañas.
  - name: Casos de campaña
    description: Endpoints para operaciones relacionadas con los casos de campaña.
  - name: Llamadas de campaña
    description: Endpoints para operaciones relacionadas con las llamadas de campaña.
  - name: Casos de inbound
    description: Endpoints para operaciones relacionadas con los casos de inbound.
paths:
  /api/v2/create_campaign/:
    post:
      tags:
        - Campañas
      summary: Crear campaña
      description: >-
        Crea una campaña en el **Bot Manager**.


        Todas las campañas se crean en estado **PAUSED**; luego, al cargar casos
        con el endpoint correspondiente, la campaña se actualiza automáticamente
        a **ONGOING**.


        Para una performance óptima se recomienda configurar ventana horaria y
        límites.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignCreateRequest'
            example:
              client_id: 116
              name: Campaña de Prueba
              description: Descripción de la campaña de prueba.
              start_date: '2022-01-31'
              call_from: '09:00'
              call_to: '21:00'
              dialing_type: HORIZONTAL_VERTICAL
              closes_eod: false
              min_phone_priority: 0
              max_phone_priority: 1
              max_calls_per_case: 3
      responses:
        '201':
          description: Campaña creada exitosamente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignDetail'
              example:
                id: 12345
                name: Campaña de prueba
                description: Descripción de la campaña de prueba.
                bot: 116
                conversation_type: OUTBOUND_VOICE
                closes_eod: false
                params:
                  call_from: '09:00:00'
                  call_to: '21:00:00'
                  max_calls_per_case: 3
                  dialing_type: HORIZONTAL_VERTICAL
                  workers: 1
                  max_phone_priority: 1
                  min_phone_priority: 0
                  start_date: '2022-01-31'
                case_stats:
                  q_loaded_cases: 0
                  q_filtered_cases: 0
                  q_resting_cases: 0
                  q_final_cases: 0
                metrics:
                  status: PAUSED
                  percentage_completed: 0
                  percentage_called: 0
                  success_rate: 0.00%
                  contactability_rate: 0
                  bot_duration: null
                  hours: 0
                created_at: '2025-10-22T10:00:00Z'
        '400':
          description: Error de validación.
        '401':
          description: No autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: El usuario no tiene permisos para crear campañas.
      security:
        - jwtAuth: []
components:
  schemas:
    CampaignCreateRequest:
      type: object
      properties:
        client_id:
          type: integer
          description: ID del Bot en la Base de Datos
          example: 116
        name:
          type: string
          description: Nombre de la campaña.
          example: Campaña de Prueba
        description:
          type: string
          description: Descripción de la campaña.
          example: Descripción de la campaña de prueba.
        start_date:
          type: string
          format: date
          description: Fecha de comienzo (YYYY-MM-DD).
          example: '2023-01-01'
        call_from:
          type: string
          description: Hora desde la cual está permitido llamar (HH:MM).
          example: '09:00'
        call_to:
          type: string
          description: Hora hasta la cual está permitido llamar (HH:MM).
          example: '21:00'
        closes_eod:
          type: boolean
          description: Indica si la campaña se cierra al final del día (EOD).
          example: false
        dialing_type:
          type: string
          enum:
            - VERTICAL
            - HORIZONTAL_VERTICAL
          description: Modo de discado.
          example: HORIZONTAL_VERTICAL
        min_phone_priority:
          type: integer
          description: >-
            Si VERTICAL: teléfono al cual llamar. Si HORIZONTAL_VERTICAL:
            teléfono desde el cual se comenzará a llamar.
          example: 0
        max_phone_priority:
          type: integer
          description: >-
            Si VERTICAL: debe coincidir con min_phone_priority. Si
            HORIZONTAL_VERTICAL: teléfono hasta el cual se llamará.
          example: 1
        max_calls_per_case:
          type: integer
          description: Cantidad de reintentos por caso.
          example: 3
      required:
        - client_id
        - name
        - description
        - start_date
        - call_from
        - call_to
        - closes_eod
        - dialing_type
        - min_phone_priority
        - max_phone_priority
        - max_calls_per_case
    CampaignDetail:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
          nullable: true
        bot:
          type: integer
        conversation_type:
          type: string
        closes_eod:
          type: boolean
        params:
          type: object
          properties:
            call_from:
              type: string
              format: time
            call_to:
              type: string
              format: time
            max_calls_per_case:
              type: integer
            dialing_type:
              type: string
            workers:
              type: integer
            max_phone_priority:
              type: integer
            min_phone_priority:
              type: integer
            start_date:
              type: string
              format: date
        case_stats:
          type: object
          properties:
            q_loaded_cases:
              type: integer
            q_filtered_cases:
              type: integer
            q_resting_cases:
              type: integer
            q_final_cases:
              type: integer
        metrics:
          type: object
          properties:
            status:
              type: string
            percentage_completed:
              type: integer
            percentage_called:
              type: integer
            success_rate:
              type: string
            contactability_rate:
              type: integer
            bot_duration:
              type: string
              nullable: true
            hours:
              type: number
              format: float
        created_at:
          type: string
          format: date-time
    UnauthorizedError:
      type: object
      properties:
        token:
          type: string
      example:
        token: El token es inválido o ha expirado
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acceso JWT. Debe ser enviado como 'Bearer {token}'.

````