Start a routine
start_runStarts a run of one of the person's routines on their iPhone, by the routine's name (any case) or id. Its card appears on the Lock Screen. The answer carries run, the new run's id, for set_value, next_step and the rest. A routine that allows several at once gets one more run each time; give each a name ("Onboarding Acme") and the values its steps or name quote ({param:company}) so they can be told apart. One that runs one at a time and is already going answers alreadyGoing with the run that is going, unless restart is true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | What this run is called, if not the routine's name. Up to 80 characters. | |
| values | No | Values the run starts with, by key — the keys the routine's steps and name quote as {param:key}. Up to 20. | |
| restart | No | For a routine that runs one at a time and is already going: end that run and begin again. Only when the person asked to start over. | |
| routine | Yes | The routine's name or id. | |
| ask_first | No | Wait for the person to say yes on the phone before it begins. Use it when they asked you to check with them first. |