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": "20250820.9",
"campaign_id": 1,
"expires_on": "2025-08-21T00:00:00Z",
"paused": true,
"status": "PENDING",
"upload_filename": "LATE_PAYMENTS_20250401.csv",
"created_at": "2025-08-20T00:00:00Z",
"deleted_at": "2025-08-20T00:00:00Z",
"deleted_reason": "User request",
"last_updated_at": "2025-08-20T00:00:00Z",
"last_updated_by": "user@email.com",
"error_message": "Invalid file format"
}
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": "20250820.9",
"campaign_id": 1,
"expires_on": "2025-08-21T00:00:00Z",
"paused": true,
"status": "PENDING",
"upload_filename": "LATE_PAYMENTS_20250401.csv",
"created_at": "2025-08-20T00:00:00Z",
"deleted_at": "2025-08-20T00:00:00Z",
"deleted_reason": "User request",
"last_updated_at": "2025-08-20T00:00:00Z",
"last_updated_by": "user@email.com",
"error_message": "Invalid file format"
}
Successful Response
The response is of type object
.