• AI reference · Area automations
automation_enrol
Start a person in an automation. Start people (by their email, each already in People) in an automation that starts by hand (trigger manual): one person with email and ref, or a list of up to 100 with people: [{ email, ref }], one yes for the whole list; it waits for the owner's yes, proposed on the task you hold (task). ref: your own key for each start; the same ref twice is one start. While the owner has paused all automations (automations shows paused_since), nobody can be started: tell the owner it waits until they switch automations back on. Skill: build-an-automation.
Where it is
In the automations area (what each automation is doing, and starting a person by hand): open it with tools_for { area: "automations" }, then call it with use_tool { name: "automation_enrol", args }.
Does it need a yes?
Needs the owner's yes: it makes a yes card, and nothing happens until the owner taps yes. Here: starting a person emails them: an automation_enrol yes.
Inputs
| Input | Type | Needed | About |
|---|---|---|---|
automation | string | yes | The automation's key (its file rules/automations/<key>.json). · up to 60 characters · format `^[a-z0-9]+(-[a-z0-9]+)*$` |
email | string | no | One person's email, as on their card in People (or people for a list). · 3 to 254 characters |
ref | string | no | With email: your key for this start; the same ref again starts nothing new. · format `^[A-Za-z0-9][A-Za-z0-9:._@-]{0,199}$` |
people | array of object | no | A list to start, one yes for all: up to 100, each address once. · 1 to 100 items |
people[].email | string | yes | The person's email, as on their card in People. · 3 to 254 characters |
people[].ref | string | yes | Your key for this start. · format `^[A-Za-z0-9][A-Za-z0-9:._@-]{0,199}$` |
task | integer | no | The task you hold: starting someone waits for the owner's yes, asked on it. · 1 or more |
run_id | string | no | The run_id from start. Pass it on every call: it keeps your task held. · 1 to 100 characters |
Example
{
"name": "automation_enrol",
"arguments": {
"automation": "automation"
}
}When it is refused
invalid: The input isn't right. The sentence names the field and the fix; nothing was done. Fix it and call again.not_found: No such thing in this company (a task, file, person, record). Check the number or name, or list first.not_allowed: Not without another step: the owner's yes, your own task held with pick_up, or a setting the owner turns on. The sentence says which.taken: Someone else holds it (another AI on that task). Pick another task.stale: It changed since you read it. Read it again and use the new version.failed: On our side or a service's, never your input. Try again in a minute; if it keeps failing, call report_problem.