Skip to main content
POST
Start a campaign

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

id
string<uuid>
required

Campaign ID.

Body

application/json
concurrency_limit
integer

Optional. Calls dialled at once, clamped to 1–10 and further clamped at dispatch by your account concurrency limit. Omit to keep the campaign's current value.

Required range: 1 <= x <= 10
retry_concurrency
integer

Optional. Slots reserved for retries; must be between 0 and the resulting concurrency_limit. Omit to keep the campaign's current value.

Required range: x >= 0

Response

The updated campaign.

success
boolean
data
object