> ## 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.

# Change campaign status

> Permite modificar el estado operativo de una campaña existente mediante una acción específica.   Las acciones disponibles son:
- **start**: inicia una campaña pausada o programada.   - **stop**: pausa una campaña en ejecución.   - **end**: finaliza una campaña.
El endpoint devuelve los datos actualizados de la campaña tras aplicar la acción.




## OpenAPI

````yaml POST /api/v2/campaigns/{campaign_id}/{action}/
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/campaigns/{campaign_id}/{action}/:
    post:
      tags:
        - Campañas
      summary: Cambiar el estado de una campaña
      description: >
        Permite modificar el estado operativo de una campaña existente mediante
        una acción específica.   Las acciones disponibles son:

        - **start**: inicia una campaña pausada o programada.   - **stop**:
        pausa una campaña en ejecución.   - **end**: finaliza una campaña.

        El endpoint devuelve los datos actualizados de la campaña tras aplicar
        la acción.
      parameters:
        - name: campaign_id
          in: path
          required: true
          schema:
            type: integer
          description: ID de la campaña sobre la cual ejecutar la acción.
        - name: action
          in: path
          required: true
          schema:
            type: string
            enum:
              - start
              - stop
              - end
          description: Acción a realizar sobre la campaña.
      responses:
        '200':
          description: Acción ejecutada exitosamente. Devuelve la campaña actualizada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignDetail'
              example:
                id: 12345
                name: Campaña Test Octubre
                description: Campaña de prueba automatizada
                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: 120
                  max_phone_priority: 1
                  min_phone_priority: 0
                  start_date: '2024-10-10'
                case_stats:
                  q_loaded_cases: 10
                  q_filtered_cases: 0
                  q_resting_cases: 0
                  q_final_cases: 0
                metrics:
                  status: ONGOING
                  percentage_completed: 0
                  percentage_called: 0
                  success_rate: 0%
                  contactability_rate: 0
                  bot_duration: null
                  hours: 0
                created_at: '2024-10-10T10:00:00Z'
        '400':
          description: Acción inválida o no permitida según el estado actual de la campaña.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensaje de error retornado por el servidor.
              examples:
                invalid_action:
                  summary: Acción inexistente
                  value:
                    error: Invalid action
                invalid_transition:
                  summary: Transición no permitida
                  value:
                    error: >-
                      Invalid action, only paused or scheduled campaigns can be
                      started.
        '401':
          description: Token inválido o expirado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: >
                  User `usuario@dominio.com` does not have an active session.
                  Please, log in.
        '403':
          description: El usuario no tiene permisos para modificar la campaña.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: >-
                  Acceso denegado. Solo el creador de la campaña puede
                  modificarla.
        '404':
          description: Campaña no encontrada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No encontrado.
      security:
        - jwtAuth: []
components:
  schemas:
    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
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acceso JWT. Debe ser enviado como 'Bearer {token}'.

````