Skip to main content
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 '
{
  "max_calls_per_day": 300,
  "scheduled_at": "2026-03-25T10:00:00Z"
}
'
{
  "data": {
    "id": "batch_c3d4e5f6",
    "name": "Q2 Outreach Campaign — Updated",
    "status": "running",
    "agent_id": "agt_f9447372",
    "from_number": "+18005559876",
    "schedule_type": "immediate",
    "scheduled_at": null,
    "timezone": "America/New_York",
    "concurrency": 10,
    "retry_attempts": 2,
    "total_contacts": 500,
    "called": 312,
    "completed": 298,
    "failed": 14,
    "pending": 188,
    "created_at": "2026-04-01T09:00:00Z",
    "updated_at": "2026-04-05T10:22:00Z"
  },
  "meta": {
    "request_id": "req_32e7531c",
    "ts": "2026-04-05T10:22:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header: Bearer <your_api_key>

Path Parameters

​
batch_call_id
string
required

Batch call ID

Body

application/json
​
name
string | null

Update campaign name

Required string length: 1 - 255
Example:

"Updated campaign name"

​
phone_number_ids
string[] | null

Update phone numbers

​
max_calls_per_day
integer | null

Update daily call limit

Required range: x >= 1
Example:

300

​
schedule_type
enum<string> | null

Update schedule type

Available options:
immediate,
scheduled
​
scheduled_at
string<date-time> | null

Update scheduled start time

Response

Batch call updated successfully

​
data
object
required
​
meta
object
required