Skip to main content
POST
cURL
Campaign calls consume credits.
A 202 response means recipients were accepted for scheduling. See run a campaign and idempotency.

Authorizations

Authorization
string
header
required

API key in the format: Bearer YOUR_KARTA_API_KEY.

Headers

X-Request-ID
string

Optional request-tracing identifier.

Body

application/json
campaign_name
string
required
Minimum string length: 1
agent_id
string
required
Minimum string length: 1
from_number
string
required

An eligible account phone number.

Minimum string length: 1
call_window
object
required
call_details
object[]
required
Minimum array length: 1
start_date
string<date> | null

Omit or pass null to use the current UTC date; scheduling interprets the date in call_window.time_zone.

end_date
string<date> | null

Last campaign date; must not precede start_date. Omit or pass null to leave it unset.

max_attempts
integer | null
default:1

Omit or pass null to use one attempt.

Required range: 1 <= x <= 4
time_gap_between_attempts
number | null
conditionally required

Minutes between retries; required and at least 1 when max_attempts > 1, otherwise ignored.

max_concurrent_dials
integer | null

Maximum concurrent calls, subject to account limits. Omit or pass null to use account settings.

Required range: 1 <= x <= 100

Response

Accepted for processing.

campaign_id
string
campaign_name
string
accepted_count
integer

Recipients accepted for scheduling; can be lower than submitted count.

config
object