POST/api/v1/automation/templates/{id}/use

Create automation rule from template

Uses one template_id to create a new automation rule under the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:create. The controller validates `{ variables }`, then service loads template, applies substitutions into template_config, creates rule via createAutomationRule, and increments automation_templates.usage_count/last_used. Missing templates surface as 500.

RBAC · automation

Path parameters

idstring <uuid>Required

Automation template UUID from automation_templates.template_id.

Request body

Content type: application/json · schema UseAutomationTemplateRequest

variablesobject

Optional variable substitutions applied to template_config before creating a new automation rule.

Response body

Success response 201 · schema AutomationRuleResponse

dataobjectRequired

rule_idstring <uuid>Required

Rule UUID generated with crypto.randomUUID when a rule is created.

tenantstring <uuid>Required

Tenant UUID scoped from API key authentication.

namestringRequired

Rule display name.

descriptionstringNullable

statusstringRequired

Current automation rule status.

Enum: activeinactivedrafterror

prioritystringRequired

Current automation rule priority.

Enum: lownormalhighcritical

trigger_typestringRequired

Trigger type used to start rule execution.

Enum: time_basedevent_basedcondition_basedmanualrecurringwebhook

trigger_configobjectRequired

Trigger configuration object stored with the rule.

conditionsarray of AutomationRuleCondition

Optional additional rule conditions.

itemsobject

fieldstringRequired

Field path evaluated for this condition.

operatorstringRequired

Enum: equalsnot_equalsgreater_thanless_thangreater_than_or_equalless_than_or_equalcontainsnot_containsstarts_withends_withinnot_inexistsnot_existsregex_match

valueany

Condition comparison value.

data_typestring

Enum: stringnumberbooleandatearrayobject

condition_logicstring

Condition combination logic.

Enum: andor

actionsarray of AutomationRuleActionRequired

Ordered action list for this rule.

itemsobject

typestringRequired

Automation action type.

Enum: email_notificationsms_notificationwebhook_calldatabase_updateticket_creationticket_updateproject_updatetime_entry_creationinvoice_generationcustom_scriptworkflow_executionsystem_command

configobjectRequired

Action configuration object. Expected keys depend on action type.

orderintegerRequired

Execution order (1-based).

≥ 1

continue_on_errorboolean

Continue execution after a failed action.

timeout_secondsinteger

Optional per-action timeout in seconds.

≥ 1

retry_attemptsinteger

Optional retry count for this action.

≥ 0 · ≤ 5

max_concurrent_executionsinteger

≥ 1

execution_timeout_minutesinteger

≥ 1

retry_failed_executionsboolean

is_templateboolean

template_categorystringNullable

tagsarray of string

itemsstring

metadataobject

notification_settingsobject

notify_on_successboolean

notify_on_failureboolean

notification_emailsarray of string

itemsstring <email>

notification_webhooksarray of string

itemsstring <uri>

created_bystring <uuid>Nullable

User UUID from API key context that created the rule.

created_atstring <date-time>

updated_atstring <date-time>

execution_countinteger

≥ 0

last_executedstring <date-time>Nullable

execution_statisticsobject

Included on GET /rules/{id} by service lookup helper.

_linksobject

HATEOAS links generated by the automation controller. Some generic links may point to methods not implemented by a route file.

Response codes

201

Automation rule created from template.

400

Invalid template UUID format or body validation failed.

401

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

403

Authenticated user lacks automation:create permission.

404

Intended not-found response for missing templates; current service may surface this as 500.

500

Unexpected failure, including current generic template not-found errors.

POST /api/v1/automation/templates/{id}/use

cURL

curl -X POST "https://algapsa.com/api/v1/automation/templates/{id}/use" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variables": {}
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/automation/templates/{id}/use", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "variables": {}
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/automation/templates/{id}/use");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""variables"": {}
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {
    "rule_id": "01HN2K7VRB9PQ3Y0000000000",
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "name": "string",
    "description": "string",
    "status": "active",
    "priority": "low",
    "trigger_type": "time_based",
    "trigger_config": {},
    "conditions": [
      {
        "field": "string",
        "operator": "equals",
        "value": null,
        "data_type": "string"
      }
    ],
    "condition_logic": "and",
    "actions": [
      {
        "type": "email_notification",
        "config": {},
        "order": 1,
        "continue_on_error": false,
        "timeout_seconds": 1,
        "retry_attempts": 0
      }
    ],
    "max_concurrent_executions": 1,
    "execution_timeout_minutes": 1,
    "retry_failed_executions": false,
    "is_template": false,
    "template_category": "string",
    "tags": [
      "string"
    ],
    "metadata": {},
    "notification_settings": {
      "notify_on_success": false,
      "notify_on_failure": false,
      "notification_emails": [
        "user@example.com"
      ],
      "notification_webhooks": [
        "https://example.com"
      ]
    },
    "created_by": "01HN2K7VRB9PQ3Y0000000000",
    "created_at": "2026-04-18T15:22:14Z",
    "updated_at": "2026-04-18T15:22:14Z",
    "execution_count": 0,
    "last_executed": "2026-04-18T15:22:14Z",
    "execution_statistics": {},
    "_links": {}
  }
}