Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-15176310985.0 KB

77568bbc2fa7

outbound.batches

Update Outbound Communication Batch

put/api/v1/outbound/batches/{batch_id}

Path parameters

batch_idstring required

Request body

pausedboolean nullable

Whether the batch is on HOLD. When on HOLD, no outreach will be made.

expires_onstring date-time nullable

Timestamp of batch expiration

call_rateinteger nullable

Target number of outreach attempts per hour for this batch. Omitted leaves the current value unchanged; a batch that has never set one inherits the campaign's hourly_rate.

auto_call_rateboolean nullable

Pace this batch automatically to finish before expires_on. Omitted leaves the current setting unchanged. Enabling it requires the batch to have an expires_on, either already set or supplied in the same update.

Example request

{
  "paused": true,
  "expires_on": "2027-01-01T06:00:00Z",
  "call_rate": 25,
  "auto_call_rate": true
}

Response

Successful Response

batch_idstring required

Unique ID for conversation batch

campaign_idinteger required

Unique ID for campaign

expires_onstring date-time nullable

Timestamp of batch expiration

pausedboolean nullable

Whether the batch is on HOLD. When on HOLD, no outreach will be made.

call_rateinteger nullable

Target number of outreach attempts per hour for this batch. When omitted, the batch inherits the campaign's hourly_rate.

auto_call_rateboolean

Pace this batch automatically to finish before expires_on, counting only the campaign's valid hours (daily_start_time..daily_end_time on active_days). The derived rate takes precedence over call_rate and over the campaign hourly_rate. Requires expires_on.

status'PENDING' | 'ACTIVE' | 'PAUSED' | 'FAILED' | 'CANCELED' | 'EXPIRED'

Status of a communication batch.

auto_call_rate_baselinenumber nullable

Read-only. The auto-paced rate first computed for this batch, set on its first dialing cycle. Subsequent cycles hold the rate within +/- 20% of it. Null until the batch has dialed, or when auto_call_rate is off.

upload_filenamestring nullable

Name of file used to create batch

dispatch_idstring nullable

A unique identifier for dipatched job

created_atstring date-time

Timestamp of batch creation

deleted_atstring date-time nullable

Timestamp of batch deletion

deleted_reasonstring nullable

Reason for batch deletion

last_updated_atstring date-time nullable

Timestamp of last change to batch

last_updated_bystring required

Email of user who last updated campaign

error_messagestring nullable

Error message if batch upload failed

Example response

{
  "batch_id": "20260815.9",
  "campaign_id": 1,
  "expires_on": "2026-08-16T00:00:00Z",
  "paused": true,
  "call_rate": 25,
  "auto_call_rate": true,
  "auto_call_rate_baseline": 25,
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
  "created_at": "2026-08-15T00:00:00Z",
  "deleted_at": "2026-08-15T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2026-08-15T00:00:00Z",
  "last_updated_by": "user@email.com",
  "error_message": "Invalid file format"
}