Update Outbound Communication Batch

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

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.outbound.batches.update({
    batchId: "<id>",
    communicationBatchUpdate: {
      paused: true,
      expiresOn: new Date("2027-01-01T06:00:00Z"),
      callRate: 25,
      autoCallRate: true,
    },
  });

  console.log(result);
}

run();

200

{
  "batch_id": "20260917.9",
  "campaign_id": 1,
  "last_updated_by": "[e-mail]",
  "expires_on": "2026-09-18T00:00:00Z",
  "paused": true,
  "call_rate": 25,
  "auto_call_rate": true,
  "status": "PENDING",
  "auto_call_rate_baseline": 25,
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
  "created_at": "2026-09-17T00:00:00Z",
  "deleted_at": "2026-09-17T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2026-09-17T00:00:00Z",
  "error_message": "Invalid file format"
}

Authorizations

Syllable-API-Key · string · header · required

Path Parameters

batch_id · string · required

Body

application/json

paused · boolean | null

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

Example:

true

expires_on · string<date-time> | null

Timestamp of batch expiration

Example:

"2027-01-01T06:00:00Z"

call_rate · integer | null

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.

Required range: 1 <= x <= 3600

Example:

25

auto_call_rate · boolean | null

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:

true

Response

200

application/json

Successful Response

batch_id · string · required

Unique ID for conversation batch

Example:

"20260917.9"

campaign_id · integer · required

Unique ID for campaign

Example:

1

last_updated_by · string · required

Email of user who last updated campaign

Example:

"[e-mail]"

expires_on · string<date-time> | null

Timestamp of batch expiration

Example:

"2026-09-18T00:00:00Z"

paused · boolean | null

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

Example:

true

call_rate · integer | null

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

Required range: 1 <= x <= 3600

Example:

25

auto_call_rate · boolean · default: false

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.

Examples:

true

false

status · enum<string> · default: PENDING

Status of batch

Available options: PENDING, ACTIVE, PAUSED, FAILED, CANCELED, EXPIRED

Examples:

"PENDING"

"ACTIVE"

"PAUSED"

"FAILED"

"CANCELED"

"EXPIRED"

auto_call_rate_baseline · number | null

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.

Example:

25

upload_filename · string | null

Name of file used to create batch

Example:

"LATE_PAYMENTS_20250401.csv"

dispatch_id · string | null

A unique identifier for dipatched job

Example:

"5ac42327fbd7e03b441650b79ae91ae1"

created_at · string<date-time>

Timestamp of batch creation

Example:

"2026-09-17T00:00:00Z"

deleted_at · string<date-time> | null

Timestamp of batch deletion

Example:

"2026-09-17T00:00:00Z"

deleted_reason · string | null

Reason for batch deletion

Example:

"User request"

last_updated_at · string<date-time> | null

Timestamp of last change to batch

Example:

"2026-09-17T00:00:00Z"

error_message · string | null

Error message if batch upload failed

Example:

"Invalid file format"