collected_records_call_automation
Use this action to call another automation once for every record in a collection.
Read the live config shape of each action type from GET /v1/automation/meta/action before you build on it.
In the automation editor, this action is Trigger another automation on collected records in the Automation calls & weblinks family. Its group is action, and it works with every trigger but needs an earlier action that creates the record collection.
Send it in the actions array of Create an automation or Update an automation. An update replaces the whole array, so include the other actions.
Example
An earlier action collects the contracts that renew next quarter. This action calls the renewal reminder automation for each of them:
{
"type": "collected_records_call_automation",
"config": {
"automation_id": 4022,
"record_collection": { "kind": "variable", "source": "action", "action_type": "record_collection", "app_id": 2087 },
"call_arguments": [
{
"variable_def": { "custom_type": "any", "label": "Renewal quarter" },
"assignment_type": "set",
"value": ["Q1 2027"]
}
]
}
}
Config
| Property | Type | Description | Example value |
|---|---|---|---|
automation_id | integer | Required. ID of the automation to call for each record. The schema lets you save without it, but validation then reports action_automation_missing. | 4022 |
record_collection | reference | Required. The collection whose records Tape calls the automation for, created by an earlier action. The schema lets you save without it, but validation then reports action_invalid and action_automation_invalid. | { "kind": "variable", "source": "action", "action_type": "record_collection", "app_id": 2087 } |
call_arguments | array of call arguments | Values for the inputs that the called automation declares. Empty when left out. | [] |
To find automation_id, see List automations. It returns the ID of each automation as id.
Each call_arguments entry has the same shape as in current_record_call_automation:
variable_def(required): the input to fill, as{ "custom_type", "label" }.assignment_type:setusesvalue(a template value),set_codeusescode(a code value). Defaultset.id: stable ID of the entry. Tape creates one when you leave it out and returns it on read.
General behavior
- No key is required by the schema. Tape saves the action without
automation_id,record_collectionorcall_arguments. - Tape calls the target automation once per record in the collection.
- Without
record_collection, validation reportsaction_invalid. It also reportsaction_automation_invalid, because Tape then has no database app to check the target against. - A
record_collectionwithout a matching earlier action fails validation withaction_variable_missing. Tape resolves the reference to the nearest earlier action that creates a collection for the sameapp_id. - The target automation must exist. Otherwise validation reports
action_automation_missing. - The target must live in the database app of the collected records and use the
automation_calledtrigger. Otherwise validation reportsaction_automation_invalid. - A paused target is a valid reference.
- Each
call_argumentslabel must match a custom variable of the target's trigger, withcustom_variable_defs_enabledset totrue. Otherwise validation reportsaction_call_argument_invalid.
Requirements
- To add or change this action through the API, your token needs the
automations:editcapability. See Capabilities. - You must administer the workspace that the automation's database app belongs to.
- An earlier action in the automation must create the collection in
record_collection, for examplecollect_app_records. - The target automation uses the
automation_calledtrigger and lives in the database app of the collected records.
Next steps
call the target for the current record only.
set up automation_called and its custom variables on the target.
references for record_collection and call_arguments.
what the validation codes mean.
a complete payload that collects records and uses the collection.
all 35 action types.