Skip to main content
POST
/
api
/
v1
/
outbound
/
batches
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.create(request={
        "batch_id": "20251124.9",
        "campaign_id": 1,
        "expires_on": parse_datetime("2025-11-25T00:00:00Z"),
        "paused": True,
    })

    # Handle response
    print(res)
{
  "batch_id": "20251124.9",
  "campaign_id": 1,
  "expires_on": "2025-11-25T00:00:00Z",
  "paused": true,
  "status": "PENDING",
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "created_at": "2025-11-24T00:00:00Z",
  "deleted_at": "2025-11-24T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2025-11-24T00:00:00Z",
  "last_updated_by": "user@email.com",
  "error_message": "Invalid file format"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json
​
batch_id
string
required

Unique ID for conversation batch

Examples:

"20251124.9"

​
campaign_id
integer
required

Unique ID for campaign

Examples:

1

​
expires_on
string<date-time> | null

Timestamp of batch expiration

Examples:

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

​
paused
boolean | null

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

Examples:

true

false

Response

Successful Response

​
batch_id
string
required

Unique ID for conversation batch

Examples:

"20251124.9"

​
campaign_id
integer
required

Unique ID for campaign

Examples:

1

​
last_updated_by
string
required

Email of user who last updated campaign

Examples:

"user@email.com"

​
expires_on
string<date-time> | null

Timestamp of batch expiration

Examples:

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

​
paused
boolean | null

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

Examples:

true

false

​
status
enum<string>

Status of batch

Available options:
PENDING,
ACTIVE,
PAUSED,
FAILED,
CANCELED,
EXPIRED
​
upload_filename
string | null

Name of file used to create batch

Examples:

"LATE_PAYMENTS_20250401.csv"

​
created_at
string<date-time>

Timestamp of batch creation

Examples:

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

​
deleted_at
string<date-time> | null

Timestamp of batch deletion

Examples:

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

​
deleted_reason
string | null

Reason for batch deletion

Examples:

"User request"

​
last_updated_at
string<date-time> | null

Timestamp of last change to batch

Examples:

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

​
error_message
string | null

Error message if batch upload failed

Examples:

"Invalid file format"

"Missing required fields"