POST/api/v1/automation/rules/bulk-execute

Bulk execute automation rules

Starts execution attempts for up to 20 automation rules for the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:execute. The controller validates bulkExecutionSchema and calls executeAutomationRule per id. sequential_execution=true runs serially; otherwise Promise.all is used. Per-rule errors are returned in a 200 response.

RBAC · automation

Request body

Content type: application/json · schema BulkExecuteRequest

automation_rule_idsarray of stringRequired

Rule UUIDs to execute.

min items 1 · max items 20

itemsstring <uuid>

execution_dataobject

Optional shared execution payload for each run.

override_conditionsboolean

Allow execution of inactive rules when true.

sequential_executionboolean

When true, executes rules sequentially; otherwise Promise.all is used.

Response body

Success response 200 · schema BulkExecuteResponse

dataobjectRequired

actionstringRequired

Enum: bulk_execute

rule_idsarray of stringRequired

itemsstring <uuid>

startedintegerRequired

≥ 0

errorsarray of stringRequired

Per-rule failures emitted as `<ruleId>: <error message>` entries.

itemsstring

sequentialboolean

messagestringRequired

Response codes

200

Bulk execution attempted for all ids; includes started count and per-id errors.

400

Body validation failed.

401

API key is missing, invalid, expired, over limit, or the key user was not found.

403

Authenticated user lacks automation:execute permission.

500

Unexpected controller or service failure before result aggregation.

POST /api/v1/automation/rules/bulk-execute

cURL

curl -X POST "https://algapsa.com/api/v1/automation/rules/bulk-execute" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "automation_rule_ids": [
    "01HN2K7VRB9PQ3Y0000000000"
  ],
  "execution_data": {},
  "override_conditions": false,
  "sequential_execution": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/automation/rules/bulk-execute", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "automation_rule_ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "execution_data": {},
    "override_conditions": false,
    "sequential_execution": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/automation/rules/bulk-execute");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""automation_rule_ids"": [
    ""01HN2K7VRB9PQ3Y0000000000""
  ],
  ""execution_data"": {},
  ""override_conditions"": false,
  ""sequential_execution"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "action": "bulk_execute",
    "rule_ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "started": 0,
    "errors": [
      "string"
    ],
    "sequential": false,
    "message": "string"
  }
}