Update campaign status
curl --request POST \
--url https://app.famulor.de/api/user/campaigns/update-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign_id": 123,
"action": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({campaign_id: 123, action: '<string>'})
};
fetch('https://app.famulor.de/api/user/campaigns/update-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.famulor.de/api/user/campaigns/update-status"
payload = {
"campaign_id": 123,
"action": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.de/api/user/campaigns/update-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaign_id' => 123,
'action' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.famulor.de/api/user/campaigns/update-status"
payload := strings.NewReader("{\n \"campaign_id\": 123,\n \"action\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"message": "Campaign started successfully.",
"success": true,
"data": {
"campaign_id": 2324,
"status": "in-progress"
}
}
{
"message": "Campaign stopped successfully.",
"success": true,
"data": {
"campaign_id": 2324,
"status": "stopped"
}
}
{
"message": "Invalid action. Must be either 'start' or 'stop'.",
"success": false
}
{
"message": "Campaign not found.",
"success": false
}
{
"message": "Access denied - Campaign does not belong to authenticated user.",
"success": false
}
{
"message": "Insufficient balance to start the campaign. Please top up your account.",
"success": false,
"data": {
"campaign_id": 2324,
"status": "draft"
}
}
Update campaign status
Start, pause or stop a Famulor outbound calling campaign via API. Programmatically control AI voice agent dialling schedules and lead processing.
POST
/
user
/
campaigns
/
update-status
Update campaign status
curl --request POST \
--url https://app.famulor.de/api/user/campaigns/update-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign_id": 123,
"action": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({campaign_id: 123, action: '<string>'})
};
fetch('https://app.famulor.de/api/user/campaigns/update-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.famulor.de/api/user/campaigns/update-status"
payload = {
"campaign_id": 123,
"action": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.de/api/user/campaigns/update-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaign_id' => 123,
'action' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.famulor.de/api/user/campaigns/update-status"
payload := strings.NewReader("{\n \"campaign_id\": 123,\n \"action\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"message": "Campaign started successfully.",
"success": true,
"data": {
"campaign_id": 2324,
"status": "in-progress"
}
}
{
"message": "Campaign stopped successfully.",
"success": true,
"data": {
"campaign_id": 2324,
"status": "stopped"
}
}
{
"message": "Invalid action. Must be either 'start' or 'stop'.",
"success": false
}
{
"message": "Campaign not found.",
"success": false
}
{
"message": "Access denied - Campaign does not belong to authenticated user.",
"success": false
}
{
"message": "Insufficient balance to start the campaign. Please top up your account.",
"success": false,
"data": {
"campaign_id": 2324,
"status": "draft"
}
}
This endpoint allows you to start or stop a campaign in the Famulor system.
Request Body
integer
required
The ID of the campaign to update
string
required
The action to perform on the campaign. Must be either “start” or “stop”
Response Fields
string
default:"Campaign started successfully."
The response message
boolean
default:"true"
Whether the operation was successful
object
Notes
- The campaign must belong to the authenticated user
- Only campaigns with valid status can be started or stopped
- When starting a campaign, sufficient leads must be available
- Stopping a campaign will abort ongoing calls
{
"message": "Campaign started successfully.",
"success": true,
"data": {
"campaign_id": 2324,
"status": "in-progress"
}
}
{
"message": "Campaign stopped successfully.",
"success": true,
"data": {
"campaign_id": 2324,
"status": "stopped"
}
}
{
"message": "Invalid action. Must be either 'start' or 'stop'.",
"success": false
}
{
"message": "Campaign not found.",
"success": false
}
{
"message": "Access denied - Campaign does not belong to authenticated user.",
"success": false
}
{
"message": "Insufficient balance to start the campaign. Please top up your account.",
"success": false,
"data": {
"campaign_id": 2324,
"status": "draft"
}
}
Related pages: Introduction and Authentication Guide, and API Integration Examples.
Was this page helpful?
⌘I

