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

Bulk update automation rule status

Updates status for up to 100 automation rules under the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:update. The controller validates ids/status with bulkStatusUpdateSchema and calls updateAutomationRule per id. Failures are collected into an errors array and still return HTTP 200 with partial-success details.

RBAC · automation

Request body

Content type: application/json · schema BulkStatusUpdateRequest

idsarray of stringRequired

Rule UUIDs from automation_rules.rule_id.

min items 1 · max items 100

itemsstring <uuid>

statusstringRequired

Status to apply to each provided rule id.

Enum: activeinactivedrafterror

Response body

Success response 200 · schema BulkStatusUpdateResponse

dataobjectRequired

actionstringRequired

Enum: bulk_status_update

statusstringRequired

Enum: activeinactivedrafterror

rule_idsarray of stringRequired

itemsstring <uuid>

updatedintegerRequired

≥ 0

errorsarray of stringRequired

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

itemsstring

messagestringRequired

Response codes

200

Bulk status update attempted for all ids; includes 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:update permission.

500

Unexpected controller or service failure before result aggregation.

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

cURL

curl -X POST "https://algapsa.com/api/v1/automation/rules/bulk-status" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "01HN2K7VRB9PQ3Y0000000000"
  ],
  "status": "active"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/automation/rules/bulk-status", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "status": "active"
  })
});
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-status");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""ids"": [
    ""01HN2K7VRB9PQ3Y0000000000""
  ],
  ""status"": ""active""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "action": "bulk_status_update",
    "status": "active",
    "rule_ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "updated": 0,
    "errors": [
      "string"
    ],
    "message": "string"
  }
}