LinX Batches Overview

Use a LinX batch to create a large volume of LinX workflow requests with a single API call. This allows you to execute a maximum of 10,000 LinX workflow requests at once.

All requests in the batch will use the same LinX template.

Create a Linx Batch

The batch request must contain the following parameters.

header

  • LinX template to use for the requests in the batch. You can provide the template name or ID.
  • Number of LinX requests to be created by the batch.
  • (Optional) Idempotency key for the request. If not provided, an idempotency key will be generated automatically.

payload

Parameters for each workflow request created for the batch. This includes:

  • Workflow title.
  • Workflow parameters. These parameters are based on the LinX template used for the batch.
  • (Optional) Request expiry period (in hours).
  • (Optional) Introductory message to display to the Customer at the start of the workflow.
ON THIS PAGE
Exit mobile version