API ReferenceWorkflows

Execute Batch

Triggers workflow execution for a batch of customers. Maximum 100 executions per request. For larger datasets, split into multiple requests.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

workflowDefinitionIdstringRequired
Workflow definition identifier to execute

Headers

x-smobi-teststringRequired

Request

Workflow execution batch request
executionslist of objectsRequired
Array of workflow executions to process

Response

Batch accepted for processing
successboolean
Whether the batch was successfully queued
executionslist of objects
List of executions with their generated IDs

Errors