Update Batch Call
curl --request PATCH \
--url https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"phone_number_ids": [
"<string>"
],
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"max_calls_per_day": 2,
"working_days": [
123
],
"max_concurrent_calls": 50,
"retry_failed": true,
"max_retry_attempts": 1
}
'import requests
url = "https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}"
payload = {
"name": "<string>",
"phone_number_ids": ["<string>"],
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"max_calls_per_day": 2,
"working_days": [123],
"max_concurrent_calls": 50,
"retry_failed": True,
"max_retry_attempts": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
phone_number_ids: ['<string>'],
scheduled_at: '2023-11-07T05:31:56Z',
timezone: '<string>',
start_time: '<string>',
end_time: '<string>',
max_calls_per_day: 2,
working_days: [123],
max_concurrent_calls: 50,
retry_failed: true,
max_retry_attempts: 1
})
};
fetch('https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}', 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.truedy.ai/api/public/v1/batch-calls/{batch_call_id}",
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([
'name' => '<string>',
'phone_number_ids' => [
'<string>'
],
'scheduled_at' => '2023-11-07T05:31:56Z',
'timezone' => '<string>',
'start_time' => '<string>',
'end_time' => '<string>',
'max_calls_per_day' => 2,
'working_days' => [
123
],
'max_concurrent_calls' => 50,
'retry_failed' => true,
'max_retry_attempts' => 1
]),
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.truedy.ai/api/public/v1/batch-calls/{batch_call_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"phone_number_ids\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"max_calls_per_day\": 2,\n \"working_days\": [\n 123\n ],\n \"max_concurrent_calls\": 50,\n \"retry_failed\": true,\n \"max_retry_attempts\": 1\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"phone_number_ids\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"max_calls_per_day\": 2,\n \"working_days\": [\n 123\n ],\n \"max_concurrent_calls\": 50,\n \"retry_failed\": true,\n \"max_retry_attempts\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"phone_number_ids\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"max_calls_per_day\": 2,\n \"working_days\": [\n 123\n ],\n \"max_concurrent_calls\": 50,\n \"retry_failed\": true,\n \"max_retry_attempts\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"agent_id": "<string>",
"phone_rotation_strategy": "<string>",
"contact_source": "<string>",
"status": "<string>",
"schedule_type": "<string>",
"timezone": "<string>",
"max_concurrent_calls": 123,
"retry_failed": true,
"max_retry_attempts": 123,
"total_contacts": 123,
"completed_contacts": 123,
"successful_contacts": 123,
"failed_contacts": 123,
"voicemail_contacts": 123,
"no_answer_contacts": 123,
"total_cost_usd": 123,
"average_duration_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"clerk_org_id": "<string>",
"phone_number_ids": [
"<string>"
],
"contact_folder_id": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"start_time": "<string>",
"end_time": "<string>",
"working_days": [
123
],
"max_calls_per_day": 123,
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"ts": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}Batch Calls
Update Batch Call
Update batch call (draft, scheduled, or paused only). Includes billing cap + reschedule.
PATCH
/
batch-calls
/
{batch_call_id}
Update Batch Call
curl --request PATCH \
--url https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"phone_number_ids": [
"<string>"
],
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"max_calls_per_day": 2,
"working_days": [
123
],
"max_concurrent_calls": 50,
"retry_failed": true,
"max_retry_attempts": 1
}
'import requests
url = "https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}"
payload = {
"name": "<string>",
"phone_number_ids": ["<string>"],
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"max_calls_per_day": 2,
"working_days": [123],
"max_concurrent_calls": 50,
"retry_failed": True,
"max_retry_attempts": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
phone_number_ids: ['<string>'],
scheduled_at: '2023-11-07T05:31:56Z',
timezone: '<string>',
start_time: '<string>',
end_time: '<string>',
max_calls_per_day: 2,
working_days: [123],
max_concurrent_calls: 50,
retry_failed: true,
max_retry_attempts: 1
})
};
fetch('https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}', 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.truedy.ai/api/public/v1/batch-calls/{batch_call_id}",
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([
'name' => '<string>',
'phone_number_ids' => [
'<string>'
],
'scheduled_at' => '2023-11-07T05:31:56Z',
'timezone' => '<string>',
'start_time' => '<string>',
'end_time' => '<string>',
'max_calls_per_day' => 2,
'working_days' => [
123
],
'max_concurrent_calls' => 50,
'retry_failed' => true,
'max_retry_attempts' => 1
]),
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.truedy.ai/api/public/v1/batch-calls/{batch_call_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"phone_number_ids\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"max_calls_per_day\": 2,\n \"working_days\": [\n 123\n ],\n \"max_concurrent_calls\": 50,\n \"retry_failed\": true,\n \"max_retry_attempts\": 1\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"phone_number_ids\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"max_calls_per_day\": 2,\n \"working_days\": [\n 123\n ],\n \"max_concurrent_calls\": 50,\n \"retry_failed\": true,\n \"max_retry_attempts\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.truedy.ai/api/public/v1/batch-calls/{batch_call_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"phone_number_ids\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"start_time\": \"<string>\",\n \"end_time\": \"<string>\",\n \"max_calls_per_day\": 2,\n \"working_days\": [\n 123\n ],\n \"max_concurrent_calls\": 50,\n \"retry_failed\": true,\n \"max_retry_attempts\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"agent_id": "<string>",
"phone_rotation_strategy": "<string>",
"contact_source": "<string>",
"status": "<string>",
"schedule_type": "<string>",
"timezone": "<string>",
"max_concurrent_calls": 123,
"retry_failed": true,
"max_retry_attempts": 123,
"total_contacts": 123,
"completed_contacts": 123,
"successful_contacts": 123,
"failed_contacts": 123,
"voicemail_contacts": 123,
"no_answer_contacts": 123,
"total_cost_usd": 123,
"average_duration_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"clerk_org_id": "<string>",
"phone_number_ids": [
"<string>"
],
"contact_folder_id": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"start_time": "<string>",
"end_time": "<string>",
"working_days": [
123
],
"max_calls_per_day": 123,
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"ts": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}{
"error": {
"code": "validation_error",
"message": "Missing required field: name",
"details": {
"errors": []
}
},
"meta": {
"request_id": "req_01JEXAMPLE",
"ts": "2026-08-21T00:00:00Z"
}
}Authorizations
Your API key. Send in the Authorization header as: Bearer
Path Parameters
Body
application/json
Update batch call; only allowed when status is draft.
Required string length:
1 - 255Available options:
random, sequential, round_robin Available options:
immediate, scheduled Limit number of calls scheduled per day
Required range:
x >= 1Required range:
1 <= x <= 100Required range:
0 <= x <= 3⌘I

