Skip to main content

Trigger a batch execution

POST 
/platform/solutions/api/v1/orgs/{orgId}/batches/{batchId}:start

Trigger execution of a batch by its ID.

Usage
POST orgs/{orgId}/batches/{batchId}:start

Parameters

  • orgId (string, required): the ID of the organization.
  • batchId (Guid, required): the ID of the batch to trigger.

Responses

  • 200 OK: returns a BatchTriggerDto with trigger details.
  • 404 Not Found: batch not found.

Security
This API requires authentication.

Request​

Responses​

OK