Send a scheduled campaign immediately
curl --request POST \
--url https://your-instance.example.com/api/campaigns/{id}/send \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/campaigns/{id}/send"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/campaigns/{id}/send', 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://your-instance.example.com/api/campaigns/{id}/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/campaigns/{id}/send"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/campaigns/{id}/send")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/{id}/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Campaign created",
"data": {
"_id": "665f1a0c0e0a4b001a2c9f10",
"name": "Q2 Lead Gen",
"status": "scheduled",
"scheduleDate": "2026-05-20T15:00:00.000Z"
}
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Campaigns
Send a scheduled campaign immediately
Triggers the bulk-send pipeline for a scheduled campaign right now, bypassing the original scheduleDate. Only campaigns in status scheduled may be sent on-demand.
POST
/
api
/
campaigns
/
{id}
/
send
Send a scheduled campaign immediately
curl --request POST \
--url https://your-instance.example.com/api/campaigns/{id}/send \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/campaigns/{id}/send"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/campaigns/{id}/send', 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://your-instance.example.com/api/campaigns/{id}/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/campaigns/{id}/send"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/campaigns/{id}/send")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/campaigns/{id}/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Campaign created",
"data": {
"_id": "665f1a0c0e0a4b001a2c9f10",
"name": "Q2 Lead Gen",
"status": "scheduled",
"scheduleDate": "2026-05-20T15:00:00.000Z"
}
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}{
"success": false,
"message": "Validation error",
"error": "name is required"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Campaign is being sent
Show child attributes
Show child attributes
Example:
{
"_id": "665f1a0c0e0a4b001a2c9f10",
"organizationId": "64ee9a8b1e7f2a0011223344",
"name": "Q2 Lead Gen",
"message": "Hi {{firstName}}, are you still interested in a quote?",
"userIds": ["64ee9a8b1e7f2a0011223399"],
"scheduleDate": "2026-05-20T15:00:00.000Z",
"process": "64eea1110000000000000001",
"contactStatus": "New Lead",
"isAutopilot": false,
"type": "sms",
"status": "scheduled",
"createdBy": {
"_id": "64ee9a8b1e7f2a0011223399",
"fullName": "Alex Rep"
},
"failedUserIds": [],
"failedDetails": [],
"stats": {
"total": 250,
"sent": 0,
"failed": 0,
"successRate": "0%"
},
"createdAt": "2026-05-18T12:34:56.000Z",
"updatedAt": "2026-05-18T12:34:56.000Z"
}
⌘I