Skip to main content
POST
Create Batch

Authorizations

Authorization
string
header
required

Project API key (sk-kupe-...) or a Supabase user JWT.

Body

application/json
org_id
string
required
project_id
string
required
agent_id
string
required
telephony_account_id
string
required
name
string
required
max_concurrent_calls
integer
default:1
Required range: x >= 1
retry_policy
RetryPolicy · object
schedule
BatchSchedule · object

{} (all fields default/None) means unscheduled — manual start/pause/ resume only, same as before this feature existed.

Response

Successful Response

id
string
required
org_id
string
required
project_id
string
required
agent_id
string
required
telephony_account_id
string
required
name
string
required
status
enum<string>
required
Available options:
draft,
running,
paused,
completed,
cancelled
max_concurrent_calls
integer
required
retry_policy
RetryPolicy · object
required
created_at
string<date-time>
required
schedule
BatchSchedule · object

{} (all fields default/None) means unscheduled — manual start/pause/ resume only, same as before this feature existed.

recipient_list_id
string | null
created_by
string | null
started_at
string<date-time> | null
completed_at
string<date-time> | null
hidden_at
string<date-time> | null