Skip to main content
PUT
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
Python (SDK)
import os
from syllable_sdk import SyllableSDK
from syllable_sdk.utils import parse_datetime


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.outbound.batches.update(batch_id="<id>", communication_batch_update={
        "paused": True,
        "expires_on": parse_datetime("2027-01-01T06:00:00Z"),
    })

    # Handle response
    print(res)
{
  "batch_id": "<string>",
  "campaign_id": 123,
  "last_updated_by": "<string>",
  "expires_on": "2025-12-12T00:00:00Z",
  "paused": true,
  "status": "PENDING",
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2025-12-11T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2025-12-11T00: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

​
campaign_id
integer
required

Unique ID for campaign

​
last_updated_by
string
required

Email of user who last updated campaign

​
expires_on
string<date-time> | null

Timestamp of batch expiration

Example:

"2025-12-12T00: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
​
upload_filename
string | null

Name of file used to create batch

Example:

"LATE_PAYMENTS_20250401.csv"

​
created_at
string<date-time>

Timestamp of batch creation

​
deleted_at
string<date-time> | null

Timestamp of batch deletion

Example:

"2025-12-11T00: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:

"2025-12-11T00:00:00Z"

​
error_message
string | null

Error message if batch upload failed

Example:

"Invalid file format"