Batch

Get batch information

Scopes: products.read, contacts.read, events.read

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

<br><a href="https://www.postman.com/omnisend-api/workspace/omnisend/overview" target="_blank">Open Postman collection</a>

get/batches/{batchID}

Request

Base URL
https://api.omnisend.com/api
URL
https://api.omnisend.com/api/batches/{batchID}
Auth
- OAuth 2
  Client credentials
  Token URL: https://app.omnisend.com/oauth2/token scopes: products.read, contacts.read, events.read
- or API key in header Authorization

Path parameters

batchIDstring required

Batch ID

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

Batch information

batchIDstring

createdAtstring

endedAtstring

endpointstring

errorsCountinteger

eventIDstring

finishedCountinteger

methodstring

originstring

startedAtstring

statusstring

totalCountinteger

Example response

{
  "batchID": "5f92cbf10cf217478ba93561",
  "createdAt": "2021-01-01T00:00:00Z",
  "endedAt": "2021-01-01T00:00:00Z",
  "endpoint": "contacts",
  "errors": [
    {
      "itemID": "5f92cbf10cf217478ba93561",
      "responseCode": 200,
      "status": "finished"
    }
  ],
  "eventID": "5f92cbf10cf217478ba93561",
  "finishedCount": 100,
  "method": "POST",
  "origin": "api",
  "responses": [
    {
      "itemID": "5f92cbf10cf217478ba93561",
      "responseCode": 200,
      "status": "finished"
    }
  ],
  "startedAt": "2021-01-01T00:00:00Z",
  "status": "finished",
  "totalCount": 100
}

Changes

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