Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Required. Non-empty.

agent_id
string<uuid>
required

Required. Must be an active agent on your account.

description
string | null
type
enum<string>
default:OUTBOUND

INBOUND campaigns are not available on the API yet.

Available options:
OUTBOUND
phone_number_ids
string<uuid>[]

Imported numbers to dial from. Each must be active, owned by you, and voice-capable.

provider
enum<string>

Legacy alternative to phone_number_ids. Required when phone_number_ids is omitted. tata_smartflo is rejected — Smartflo does not support streaming voice bots on campaigns.

Available options:
twilio,
exotel,
mcube,
tata_smartflo
concurrency_limit
integer

Simultaneous first-attempt calls.

retry_concurrency
integer

Simultaneous retry calls.

retry_count
integer

Retries per contact after the first call.

cooldown_minutes
integer

Fixed wait between retries.

retry_delays_minutes
integer[]

Per-attempt waits. Overrides cooldown_minutes.

callback_enabled
boolean
default:true

Set false to stop calls asking for a callback time.

Response

Campaign created in draft status.

success
boolean
data
object