Skip to main content
POST
Apply automation template
Famulor 1.0 API (legacy). This page applies only to Famulor 1.0 (app.famulor.de) and is retained for legacy compatibility. For the current platform, use the Famulor 2.0 API reference.
This endpoint creates an automation from a template (see List automation templates), runs a real test, and — for assistant-event templates — attaches the automation to the assistant once the test passes. It returns the same envelope as Create automation.
Templates marked side_effects: true really send messages or start calls during their test run — applying them requires confirm_side_effects: true, and the test targets the real values you supplied. Never apply a template with example or guessed values.

Path Parameters

string
required
The template key (from List automation templates). An unknown key returns a 404.

Request body

object
The template’s parameters as key-value pairs — see the template’s params list for what each one needs. Missing required parameters return a 422 (missing_params) listing exactly what is needed. Max 64 KB.
integer
The assistant the resulting automation attaches to. Required for templates with requires_assistant: true.
string
A custom name for the automation (max 255 characters); defaults to the template name
boolean
Required (true) for templates marked side_effects: true

Response

The Create automation envelope: automation_id, webhook_url (for webhook-triggered templates such as lead-intake-webhook and the mid-call lookup ones; null for assistant-event templates), status (active / active_untested / test_failed), test (run_status + per-step outcomes), response, binding. Returns 201 when the automation is active, 200 when its test run failed. A template whose test run parks at a Delay step (e.g. post-call-callback) reports run_status: "PAUSED" — that is success, not a failure: every step before the delay ran, and the run resumes at the target time.

Error codes (422)

Hard failures return {"message": "...", "error": "<code>", "params": ...} and nothing is created. Notable codes: