PUT
/
api
/
v1
/
outbound
/
batches

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json
​
batch_id
string
required

Unique ID for conversation batch

​
campaign_id
integer
required

Unique ID for campaign

​
rate
integer
required

Number of outreach per hour

​
source
string
required

Source phone number, email, or SMS number

​
type
string
required

Call, SMS, email

​
retry_count
integer
default:
0

Number of retries per target

​
retry_interval
string | null

How long (30m, 12h, 7d) to wait before retrying

Response

200 - application/json
​
batch_id
string
required

Unique ID for conversation batch

​
campaign_id
integer
required

Unique ID for campaign

​
last_updated_by
string
required

User who last updated campaign

​
rate
integer
required

Number of outreach per hour

​
source
string
required

Source phone number, email, or SMS number

​
type
string
required

Call, SMS, email

​
created_at
string

Timestamp of batch creation

​
deleted_at
string | null

Timestamp of batch deletion

​
deleted_reason
string | null

Reason for batch deletion

​
dispatch_id
string | null

Unique ID of worker assigned to batch

​
last_worked_on
string | null

Timestamp of last batch activity

​
retry_count
integer
default:
0

Number of retries per target

​
retry_interval
string | null

How long (30m, 12h, 7d) to wait before retrying

​
status
enum<string>

Status of batch

Available options:
NEW,
LOADED,
ACTIVE,
INACTIVE,
PAUSED,
DELETED,
COMPLETED
List Outbound Communication BatchesGet Outbound Communication Batch