Skip to main content
PUT
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
Typescript (SDK)
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"),
    },
  });

  console.log(result);
}

run();
{
  "batch_id": "<string>",
  "campaign_id": 123,
  "last_updated_by": "<string>",
  "expires_on": "2026-03-25T00:00:00Z",
  "paused": true,
  "status": "PENDING",
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2026-03-24T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2026-03-24T00: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"

Response

Successful Response

​
batch_id
string
required

Unique ID for conversation batch

Example:

"20260324.9"

​
campaign_id
integer
required

Unique ID for campaign

Example:

1

​
last_updated_by
string
required

Email of user who last updated campaign

Example:

"user@email.com"

​
expires_on
string<date-time> | null

Timestamp of batch expiration

Example:

"2026-03-25T00:00:00Z"

​
paused
boolean | null

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

Example:

true

​
status
enum<string>
default:PENDING

Status of batch

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

"PENDING"

"ACTIVE"

"PAUSED"

"FAILED"

"CANCELED"

"EXPIRED"

​
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-03-24T00:00:00Z"

​
deleted_at
string<date-time> | null

Timestamp of batch deletion

Example:

"2026-03-24T00: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-03-24T00:00:00Z"

​
error_message
string | null

Error message if batch upload failed

Example:

"Invalid file format"