CYcyberimpact
Batches

Retrieve a batch

Retrieve a specific batch based on its ID. This is useful to check whether a batch has finished processing and to get the results. Some requests in the batch may have succeeded while others failed. The result field provides the details.

get/batches/{id}

Request

Path parameters

idinteger required

The batch's numerical ID

Query parameters

showErrorDetailsboolean

Return the details of invalid rows

Response

The batch details

idinteger
batchTypestring
batchJsonobject
createdOnstring
statusstring

NEW, PROCESSING, or COMPLETED

Example response

{
  "id": 176,
  "batchType": "unsubscribe",
  "batchJson": {
    "batchType": "unsubscribe",
    "ids": [
      1,
      2,
      3
    ]
  },
  "createdOn": "2015-10-28 11:55:56.217",
  "status": "NEW"
}

Changes

No recorded changes to this operation across all 1 revision of this API.