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

# Créer une campagne

> Crée une campagne sortante à partir d'une liste de contacts.



## OpenAPI

````yaml openapi.json POST /campaign/create
openapi: 3.1.0
info:
  title: Bookivox API
  version: 1.0.0
  description: >-
    API server-to-server Bookivox. Tous les chemins sont relatifs au préfixe
    `/api/v1/api`. Authentification par en-tête `X-API-Key` (l'en-tête
    `Authorization` est interdit).
servers:
  - url: https://api.bookivox.com/api/v1/api
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Clés API
    description: Créer, lister et archiver les clés API de l'organisation.
  - name: Agents
    description: Créer et piloter les agents vocaux (workflows).
  - name: Templates
    description: Partir d'un modèle d'agent prêt à l'emploi.
  - name: Chat texte
    description: Tester un agent dans une session de chat texte.
  - name: Campagnes
    description: Exécuter un agent en masse sur une liste de contacts.
  - name: Base de connaissance
    description: Gérer et interroger les documents de connaissance.
  - name: Outils
    description: Gérer les outils attachables à un nœud agent.
  - name: Crédits et usage
    description: Consulter le solde, la consommation et les statistiques.
  - name: Téléphonie
    description: >-
      Lire les configurations téléphonie et les numéros (lecture seule via clé
      API).
  - name: Node-types
    description: Catalogue des types de nœuds et de leurs propriétés.
paths:
  /campaign/create:
    post:
      tags:
        - Campagnes
      summary: Créer une campagne
      description: >-
        Crée une campagne sortante. `workflow_id` et
        `telephony_configuration_id` sont des **UUID publics** (chaînes), jamais
        des identifiants internes.
      operationId: createCampaign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - workflow_id
                - source_type
                - source_id
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                workflow_id:
                  type: string
                  description: UUID public de l'agent.
                source_type:
                  type: string
                  pattern: ^csv$
                source_id:
                  type: string
                  description: '`file_key` renvoyé par l''upload CSV.'
                telephony_configuration_id:
                  type: string
                  nullable: true
                max_concurrency:
                  type: integer
                  minimum: 1
                  maximum: 100
                  nullable: true
                retry_config:
                  type: object
                  nullable: true
                schedule_config:
                  type: object
                  nullable: true
                circuit_breaker:
                  type: object
                  nullable: true
            example:
              name: Campagne demo
              workflow_id: c1f0a2e4-...-9b7
              source_type: csv
              source_id: opaque-reference
      responses:
        '201':
          description: Campagne créée.
        '422':
          description: Corps invalide.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Votre clé API Bookivox. Créez-la dans le dashboard, rubrique Clés API.
        L'en-tête `Authorization` est interdit sur cette surface.

````

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