Skip to main content
POST
/
campaigns
/
{campaign_id}
/
candidates
Ajoute des candidats à une campagne
curl --request POST \
  --url https://app.voicehire.io/api/v1/campaigns/{campaign_id}/candidates \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "candidates": [
    {
      "first_name": "Jean",
      "last_name": "Dupont",
      "phone": "0612345678",
      "email": "[email protected]"
    }
  ]
}
'
{
  "campaign_id": "abc123def456",
  "candidates_added": 23,
  "candidates_skipped": 2,
  "calls_queued": 23,
  "errors": [
    {
      "index": 5,
      "error": "Numéro de téléphone invalide"
    }
  ]
}

​
Paramètres

​
campaign_id
string
required
Identifiant unique de la campagne

​
Corps de la requête

​
candidates
array
required
Liste des candidats à ajouter (maximum 100)

​
Réponse

{
  "campaign_id": "abc123def456",
  "candidates_added": 23,
  "candidates_skipped": 2,
  "calls_queued": 23,
  "errors": [
    {
      "index": 5,
      "error": "Numéro de téléphone invalide"
    }
  ]
}
​
campaign_id
string
required
Identifiant de la campagne
​
candidates_added
integer
required
Nombre de candidats ajoutés avec succès
​
candidates_skipped
integer
required
Nombre de candidats ignorés (déjà présents dans la campagne)
​
calls_queued
integer
required
Nombre d’appels mis en file d’attente
​
errors
array
Liste des erreurs rencontrées

​
Exemple de requête

curl -X POST https://app.voicehire.io/api/v1/campaigns/abc123def456/candidates \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "candidates": [
      {
        "first_name": "Jean",
        "last_name": "Dupont",
        "phone": "0612345678",
        "email": "[email protected]"
      },
      {
        "first_name": "Marie",
        "last_name": "Martin",
        "phone": "0687654321",
        "email": "[email protected]"
      }
    ]
  }'

​
Notes importantes

  • Les candidats avec le même numéro de téléphone qu’un candidat existant seront ignorés
  • Les appels sont automatiquement déclenchés après l’ajout
  • Maximum 100 candidats par requête

​
Codes d’erreur

CodeDescription
400Données invalides (format incorrect, champs manquants)
401Clé API manquante ou invalide
402Crédits insuffisants
404Campagne non trouvée

Authorizations

​
X-API-Key
string
header
required

Clé API VoiceHire (format vh_live_...)

Path Parameters

​
campaign_id
string
required

ID de la campagne

Body

application/json
​
candidates
object[]
required
Maximum array length: 100

Response

Candidats traités

​
campaign_id
string
​
candidates_added
integer

Nombre de candidats ajoutés

​
candidates_skipped
integer

Nombre de candidats ignorés (déjà existants)

​
calls_queued
integer

Nombre d'appels en attente

​
errors
object[]