Batch Object

The Batch object represents details for a campaign batch file.

Attributes

string (UUID)

Unique ID assigned to the batch.

campaignId

string (UUID)

Unique ID assigned to the campaign.

description

string

Description of the batch.

externalId

string

Your organization’s internal reference number assigned to the batch. This reference number is not used by RocketCOMS.

startDate

string, format: YYYY-MM-DD

Date to start processing the batch messages. Cannot be a date in the past.

endDate

string, format: YYYY-MM-DD

Date to stop processing the batch messages. If endDate is not provided, the batch will be processed until all messages are sent.

startTime

string, format: hh:mm

Time to start processing the batch messages. Messages will only be sent during the period defined by startTime and endTime.

endTime

string, format: hh:mm

Time to stop processing the batch messages. Messages will only be sent during the period defined by startTime and endTime.

status

string enum, values: COMPLETED, UPLOADING, ERROR, PENDING, IN_PROCESS

Current status of the batch.

createdAt

string (date-time)

Date and time the batch was created.

updatedAt

string (date-time)

Date and time the batch was last updated.

finishedAt

string (date-time)

Date and time the batch was completed.

Batch Object

				
					{
  "id": "32df8770-ee48-46e7-a8c7-9ec478883076",
  "campaignId": "05ee2300-51cd-4021-b28d-11597cf9a175",
  "description": "Spring Sale",
  "externalId": "a7896",
  "startDate": "2022-04-25",
  "endDate": "2022-04-25",
  "startTime": "02:00:00",
  "endTime": "04:00:00",
  "status": "DELIVERED",
  "createdAt": "2022-04-24T16:51:03.419Z",
  "updatedAt": "2022-04-24T16:51:03.419Z",
  "finishedAt": "2022-04-25T04:00:03.419Z"
}