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"
}
'import requests
url = "https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status"
payload = { "status": "paused" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'paused'})
};
fetch('https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'paused'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status"
payload := strings.NewReader("{\n \"status\": \"paused\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"paused\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"paused\"\n}"
response = http.request(request)
puts response.read_body{
"campaign_id": "abc123def456",
"status": "paused"
}
Campagnes
Mettre à jour le statut d'une campagne
Change le statut d’une campagne pour contrôler le flux des appels
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"
}
'import requests
url = "https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status"
payload = { "status": "paused" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'paused'})
};
fetch('https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'paused'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status"
payload := strings.NewReader("{\n \"status\": \"paused\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"paused\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/campaigns/{campaign_id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"paused\"\n}"
response = http.request(request)
puts response.read_body{
"campaign_id": "abc123def456",
"status": "paused"
}
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 appelspaused- Mettre en pause la campagne (arrêter les nouveaux appels)completed- Marquer la campagne comme terminée
Réponse
{
"campaign_id": "abc123def456",
"status": "paused"
}
string
required
Identifiant unique de la campagne
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"
}'
import requests
response = requests.patch(
"https://app.voicehire.io/api/v1/campaigns/abc123def456/status",
headers={
"X-API-Key": "vh_live_XXXXXXXXXXXXX",
"Content-Type": "application/json"
},
json={
"status": "paused"
}
)
const axios = require('axios');
const response = await axios.patch(
'https://app.voicehire.io/api/v1/campaigns/abc123def456/status',
{
status: 'paused'
},
{
headers: {
'X-API-Key': 'vh_live_XXXXXXXXXXXXX',
'Content-Type': 'application/json'
}
}
);
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
| Code | Description |
|---|---|
| 400 | Statut invalide ou transition non autorisée |
| 401 | Clé API manquante ou invalide |
| 404 | Campagne non trouvée |
Authorizations
Clé API au format vh_live_XXXXX
Path Parameters
Identifiant de la campagne
Body
application/json
Nouveau statut
Available options:
active, paused, completed 
