Recipient Batch Object

The Recipient Batch object represents details for a batch of recipients.

Attributes

succeeded

number

Number of recipients that were successfully created from the batch file.

failed

number

Number of recipients that failed to be created from the batch file.

skipped

number

Number of recipients in the batch file that were skipped because these recipients already exist in RocketCOMS.

errorDetails

array

Any batch file processing errors.

lineNumber

number

Line number of the failed item in the CSV file.

description

string

Details about the error.

recipientsListId

string

Unique ID for the recipient list created from the batch file.

Recipient Batch Object

				
					{
  "succeeded": 100,
  "failed": 1,
  "skipped": 8,
  "errorDetails": [
    {
      "lineNumber": 21,
      "description": "error description"
    }
  ],
  "recipientsListId": "e2bf6960-9ac7-4448-8154-d1e19d9379a1"
}