Skip to main content
PATCH
Update Batch Call

Authorizations

Authorization
string
header
required

Your API key. Send in the Authorization header as: Bearer

Path Parameters

batch_call_id
string
required

Body

application/json

Update batch call; only allowed when status is draft.

name
string | null
Required string length: 1 - 255
phone_number_ids
string[] | null
phone_rotation_strategy
enum<string> | null
Available options:
random,
sequential,
round_robin
schedule_type
enum<string> | null
Available options:
immediate,
scheduled
scheduled_at
string<date-time> | null
timezone
string | null
start_time
string | null
end_time
string | null
max_calls_per_day
integer | null

Limit number of calls scheduled per day

Required range: x >= 1
working_days
integer[] | null
max_concurrent_calls
integer | null
Required range: 1 <= x <= 100
retry_failed
boolean | null
max_retry_attempts
integer | null
Required range: 0 <= x <= 3

Response

Successful Response

data
PublicBatchResource · object
required
meta
ResponseMeta · object
required

Metadata included in every API response.