API Reference
API Reference

Update Outbound Communication Batch

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

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

batch_id string path required

Request body

application/json

body CommunicationBatchUpdate required
4 fields
pausedboolean | nulloptional

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

expires_onstring (date-time) | nulloptional

Timestamp of batch expiration

call_rateinteger | nulloptional

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.

Minimum 1Maximum 3600
auto_call_rateboolean | nulloptional

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.

Request example
{
  "paused": "string",
  "expires_on": "string",
  "call_rate": "string",
  "auto_call_rate": "string"
}

Responses

200Successful Response

application/json

response CommunicationBatch required
16 fields
batch_idstringrequired

Unique ID for conversation batch

campaign_idintegerrequired

Unique ID for campaign

expires_onstring (date-time) | nulloptional

Timestamp of batch expiration

pausedboolean | nulloptional

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

call_rateinteger | nulloptional

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

Minimum 1Maximum 3600
auto_call_ratebooleanoptional

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.

Default false
statusenum<string>optional

Status of batch

Allowed values ["PENDING","ACTIVE","PAUSED","FAILED","CANCELED","EXPIRED"]Default PENDING
auto_call_rate_baselinenumber | nulloptional

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 | nulloptional

Name of file used to create batch

dispatch_idstring | nulloptional

A unique identifier for dipatched job

created_atstring (date-time)optional

Timestamp of batch creation

deleted_atstring (date-time) | nulloptional

Timestamp of batch deletion

deleted_reasonstring | nulloptional

Reason for batch deletion

last_updated_atstring (date-time) | nulloptional

Timestamp of last change to batch

last_updated_bystringrequired

Email of user who last updated campaign

error_messagestring | nulloptional

Error message if batch upload failed

Response example
{
  "batch_id": "string",
  "campaign_id": 0,
  "expires_on": "string",
  "paused": "string",
  "call_rate": "string",
  "auto_call_rate": false,
  "status": "PENDING",
  "auto_call_rate_baseline": "string",
  "upload_filename": "string",
  "dispatch_id": "string",
  "created_at": "string",
  "deleted_at": "string",
  "deleted_reason": "string",
  "last_updated_at": "string",
  "last_updated_by": "string",
  "error_message": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}