outbound.batches
Update Outbound Communication Batch
PUT
Authorizations
Path Parameters
Body
application/json
Whether the batch is on HOLD. When on HOLD, no outreach will be made.
Example:
true
Timestamp of batch expiration
Example:
"2027-01-01T06:00:00Z"
Response
200
application/json
Successful Response
Unique ID for conversation batch
Example:
"20250419.9"
Unique ID for campaign
Example:
1
Email of user who last updated campaign
Example:
"user@email.com"
Timestamp of batch expiration
Example:
"2025-04-20T00:00:00Z"
Whether the batch is on HOLD. When on HOLD, no outreach will be made.
Example:
true
Status of batch
Available options:
PENDING
, ACTIVE
, PAUSED
, FAILED
, CANCELED
, EXPIRED
Name of file used to create batch
Example:
"LATE_PAYMENTS_20250401.csv"
Timestamp of batch creation
Example:
"2025-04-19T00:00:00Z"
Timestamp of batch deletion
Example:
"2025-04-19T00:00:00Z"
Reason for batch deletion
Example:
"User request"
Timestamp of last change to batch
Example:
"2025-04-19T00:00:00Z"
Error message if batch upload failed
Example:
"Invalid file format"