Authorizations
Path Parameters
Body
application/json
Response
Successful Response
Unique ID for conversation batch
Examples:
"20250917.9"
Unique ID for campaign
Examples:
1
Email of user who last updated campaign
Examples:
"user@email.com"
Timestamp of batch expiration
Examples:
"2025-09-18T00:00:00Z"
Whether the batch is on HOLD. When on HOLD, no outreach will be made.
Examples:
true
false
Status of batch
Available options:
PENDING
, ACTIVE
, PAUSED
, FAILED
, CANCELED
, EXPIRED
Name of file used to create batch
Examples:
"LATE_PAYMENTS_20250401.csv"
Timestamp of batch creation
Examples:
"2025-09-17T00:00:00Z"
Timestamp of batch deletion
Examples:
"2025-09-17T00:00:00Z"
Reason for batch deletion
Examples:
"User request"
Timestamp of last change to batch
Examples:
"2025-09-17T00:00:00Z"
Error message if batch upload failed
Examples:
"Invalid file format"
"Missing required fields"