Skip to main content
PATCH
Modifier le statut d'une campagne

Paramètres

string
required
Identifiant unique de la campagne

Corps de la requête

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

string
required
Identifiant unique de la campagne
string
required
Nouveau statut de la campagne

Exemple de requête

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

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