curl --request POST \
--url https://api.upliftai.org/v1/campaigns/{campaignId}/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheduledFor": "2026-12-24T09:30:00.000Z"
}
'import requests
url = "https://api.upliftai.org/v1/campaigns/{campaignId}/schedule"
payload = { "scheduledFor": "2026-12-24T09:30:00.000Z" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({scheduledFor: '2026-12-24T09:30:00.000Z'})
};
fetch('https://api.upliftai.org/v1/campaigns/{campaignId}/schedule', 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://api.upliftai.org/v1/campaigns/{campaignId}/schedule",
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([
'scheduledFor' => '2026-12-24T09:30:00.000Z'
]),
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://api.upliftai.org/v1/campaigns/{campaignId}/schedule"
payload := strings.NewReader("{\n \"scheduledFor\": \"2026-12-24T09:30:00.000Z\"\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))
}HttpResponse<String> response = Unirest.post("https://api.upliftai.org/v1/campaigns/{campaignId}/schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheduledFor\": \"2026-12-24T09:30:00.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upliftai.org/v1/campaigns/{campaignId}/schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduledFor\": \"2026-12-24T09:30:00.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"campaignId": "bf9d18e9-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"organizationId": "a12b7e74-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"projectId": "c782a4ec-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Shifa Clinic December appointment reminders",
"state": "scheduled",
"config": {
"assistant": {
"assistantId": "26932cc0-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"contacts": {
"listId": "7c1f4a90-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"schedule": {
"scheduledFor": "2026-12-24T09:30:00.000Z"
}
},
"trigger": {
"kind": "list"
},
"steps": [
"call"
],
"mode": "bounded",
"createdAt": "2026-08-18T05:18:26.271Z",
"updatedAt": "2026-08-18T05:18:54.747Z",
"version": 2
}{
"message": [
"scheduledFor must be a valid ISO 8601 date string"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "invalid authorization",
"error": "Unauthorized",
"statusCode": 401
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Campaign not found: 00000000-0000-4000-8000-000000000000",
"error": "Not Found",
"statusCode": 404
}{
"message": "illegal campaign transition: scheduled --schedule-->",
"error": "Conflict",
"statusCode": 409
}Schedule a campaign launch
The campaign moves to scheduled and sits there until scheduledFor, when the platform launches it — even outside the calling window; dialing then waits for the window to open. The contact list is snapshotted at that launch moment, not now: edits to the list before scheduledFor make it in, edits after never reach the campaign. Only a draft campaign can be scheduled — to move a time already set, PATCH config.schedule.scheduledFor.
curl --request POST \
--url https://api.upliftai.org/v1/campaigns/{campaignId}/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheduledFor": "2026-12-24T09:30:00.000Z"
}
'import requests
url = "https://api.upliftai.org/v1/campaigns/{campaignId}/schedule"
payload = { "scheduledFor": "2026-12-24T09:30:00.000Z" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({scheduledFor: '2026-12-24T09:30:00.000Z'})
};
fetch('https://api.upliftai.org/v1/campaigns/{campaignId}/schedule', 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://api.upliftai.org/v1/campaigns/{campaignId}/schedule",
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([
'scheduledFor' => '2026-12-24T09:30:00.000Z'
]),
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://api.upliftai.org/v1/campaigns/{campaignId}/schedule"
payload := strings.NewReader("{\n \"scheduledFor\": \"2026-12-24T09:30:00.000Z\"\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))
}HttpResponse<String> response = Unirest.post("https://api.upliftai.org/v1/campaigns/{campaignId}/schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheduledFor\": \"2026-12-24T09:30:00.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upliftai.org/v1/campaigns/{campaignId}/schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheduledFor\": \"2026-12-24T09:30:00.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"campaignId": "bf9d18e9-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"organizationId": "a12b7e74-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"projectId": "c782a4ec-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Shifa Clinic December appointment reminders",
"state": "scheduled",
"config": {
"assistant": {
"assistantId": "26932cc0-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"contacts": {
"listId": "7c1f4a90-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
"schedule": {
"scheduledFor": "2026-12-24T09:30:00.000Z"
}
},
"trigger": {
"kind": "list"
},
"steps": [
"call"
],
"mode": "bounded",
"createdAt": "2026-08-18T05:18:26.271Z",
"updatedAt": "2026-08-18T05:18:54.747Z",
"version": 2
}{
"message": [
"scheduledFor must be a valid ISO 8601 date string"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "invalid authorization",
"error": "Unauthorized",
"statusCode": 401
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Campaign not found: 00000000-0000-4000-8000-000000000000",
"error": "Not Found",
"statusCode": 404
}{
"message": "illegal campaign transition: scheduled --schedule-->",
"error": "Conflict",
"statusCode": 409
}Authorizations
Project API key (sk_api_…).
Path Parameters
Body
When to launch. Date-only (2026-12-24) and offset-less (2026-12-24T09:30:00) forms are also accepted, so send Z or an explicit offset to keep the time unambiguous. A time already in the past is not rejected — it launches on the next sweep.
Response
The campaign, now scheduled.
120Where the campaign is in its lifecycle:
draft— created, nothing dialsscheduled— the platform launches it atconfig.schedule.scheduledForlaunching— the contact list is being materialized into a run; transientlaunch_failed— materialization failed;lastErrorsays which phase, and launching again retries itrunning— the dialer is placing callspaused— no new dials; calls already in flight run to their enddraining— closed to new work, waiting only on in-flight callscompleted— terminal
draft, scheduled, launching, launch_failed, running, paused, draining, completed Fixed at create. bounded snapshots the contact list at launch and completes itself once the queue empties; continuous keeps accepting appended contacts and completes only after a close. Absent on older campaigns; read that as bounded.
bounded, continuous Returned exactly as stored — a section never set is absent rather than filled in with defaults.
Show child attributes
Show child attributes
When the campaign was closed to new work. Continuous campaigns only; closing does not change state, so expect running until the drain begins.
The single run created at first launch; a retried launch reuses it.
First launch. Unchanged by pauses, resumes and launch retries.
Why the last launch failed. Cleared by a launch that gets further.
Show child attributes
Show child attributes
Set when the platform acts on its own, and says why. Expect Paused: out of credits, or Paused: assistant version not found when the campaign's assistant was deleted. The assistant can't be changed after launch, so a resume won't fix that one. Cleared on resume.
"Paused: out of credits"
True once any call has been graded, after which config.scorecard is frozen. Absent until then.
How the campaign takes work. Always {"kind": "list"} today.
Show child attributes
Show child attributes
What each contact goes through. Always ["call"] today.
Increments on every accepted write — compare it across reads to tell a real change from an unchanged poll.
