Skip to main content
PATCH
/
api
/
v1
/
campaigns
/
{campaign_id}
/
status
Modifier le statut d'une campagne
curl --request PATCH \
  --url https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "paused"
}
'
{
  "campaign_id": "abc123def456",
  "status": "paused"
}

​
Paramètres

​
campaign_id
string
required
Identifiant unique de la campagne

​
Corps de la requête

​
status
string
required
Nouveau statut de la campagneValeurs possibles:
  • active - Activer la campagne et reprendre les appels
  • paused - Mettre en pause la campagne (arrêter les nouveaux appels)
  • completed - Marquer la campagne comme terminée

​
Réponse

{
  "campaign_id": "abc123def456",
  "status": "paused"
}
​
campaign_id
string
required
Identifiant unique de la campagne
​
status
string
required
Nouveau statut de la campagne

​
Exemple de requête

curl -X PATCH https://app.voicehire.io/api/v1/campaigns/abc123def456/status \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "paused"
  }'

​
Notes importantes

  • Active → Paused: Les appels en cours continuent, mais aucun nouvel appel n’est initié et aucun nouveau candidat ne peut être ajouté
  • Paused → Active: La campagne accepte à nouveau l’ajout de nouveaux candidats
  • Any → Completed: Statut définitif, la campagne ne peut plus être réactivée

​
Codes d’erreur

CodeDescription
400Statut invalide ou transition non autorisée
401Clé API manquante ou invalide
404Campagne non trouvée

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Path Parameters

​
campaign_id
string
required

Identifiant de la campagne

Body

application/json
​
status
enum<string>
required

Nouveau statut

Available options:
active,
paused,
completed

Response

Statut mis à jour

​
campaign_id
string
​
status
string