Create or retrieve a batch

This endpoint can be used to do the following:

  • Create a new batch record and generate a url for uploading your batch file
  • Retrieve information about an existing batch, such as the status or a link to the batch results.


Because this endpoint can be used to both create and retrieve batches, it supports two request and response models. Both models are documented below.

  • Option 1 is for creating batches
  • Option 2 is for retrieving batches

Request and response examples for both models are available on the right-hand side of this page.

Click Try It! to start a request and see the response here!