AddActionBody

Body for Add Action. `action_id` is the template; `after` (optional) is an `action_instance_id`; `name` (optional) overrides the template's default display name. Everything Configure Action accepts — `inputs`, `run_if`, `continue_workflow_if_action_fails`, `note`, `output_types` — can be sent here too, so an action can be created and fully configured in one request instead of two. Same shapes, same semantics, same `warnings[]`.

Properties

action_idstringrequired

Action template identifier from the action catalog (e.g. `enrich_company_linkedin_profile`).

afterstring

Insert after this `action_instance_id`. Omit to append to the end of the chain. NOTE: this is an instance ID, not an `action_id`.

namestring

Optional display name for the new action instance. Whitespace-only values are ignored.

inputsobject

Optional. Configure the action in the same request instead of following up with Configure Action — one call per action instead of two. Identical semantics to Configure Action's `inputs` (same accepted value shapes, same reference translation, same `warnings[]` codes), because it runs the same engine. Any warnings come back on the 201. References may point at actions upstream of this one; a reference to an action that runs later is reported as a `downstream_reference` warning. On a hard validation failure nothing is created — you do not get a half-configured action to clean up.

run_ifobject | null

Optional gate deciding whether this action runs for a given row. Pass `null` to clear an existing condition. Omit to leave the existing condition unchanged. `conditions` is an array of AND/OR condition GROUPS — the same shape as the filter action's `path_conditions`. The outer array is groups, joined by each group's `combinator` (AND/OR); each group's `conditions` are leaf conditions, joined by each leaf's `combinator`. The first group's and first leaf's `combinator` is ignored. A single condition is just one group with one leaf. **Supported `operator` values depend on the variable's stored type** — the type is derived from the sheet's chain, so you don't pass it. - **Universal** (any type): `is`, `is not`, `is empty`, `is not empty`. `is empty` / `is not empty` ignore `values`. - **String / email / url / imageUrl**: `contains`, `does not contain`, `starts with`, `does not start with`, `ends with`, `does not end with`. Matching is case-insensitive. - **Number / currency**: `greater than`, `less than`, `greater than or equal to`, `less than or equal to`, `is between` (pass `[min, max]`). - **Date**: `is after`, `is before`, `is between` (pass `[start, end]`). Values are parsed by `moment(...)`. - **Array / structured_array / json**: `contains`, `does not contain`. Pass `values` as an array of strings — number / date matchers coerce as needed.

conditionsarray of

AND/OR condition groups. Outer array = groups (joined by each group's `combinator`); each group's `conditions` = leaf conditions (joined by each leaf's `combinator`). A single condition is one group with one leaf.

conditionsarray ofrequired
variablestringrequired

Reference token whose resolved value gets compared. Use `{{input.<field_name>}}` for a sheet input, or `{{<action_instance_id>.<field_name>}}` for an upstream action's output.

operatorstringrequired

Comparison operator. See the per-type list above.

valuesarray of

Values to compare against. Required for most operators; ignored by `is empty` / `is not empty`. For `is between`, pass `[low, high]`.

combinatorstring

Joins this leaf with the previous one in the group. Ignored on the first leaf.

"AND""OR"
combinatorstring

Joins this group with the previous one. Ignored on the first group.

"AND""OR"
continue_workflow_if_run_condition_not_metboolean

When `true`, downstream actions still run for a row even when this action's condition isn't met (the action itself is skipped). When `false` (default), the row stops at this action when the condition isn't met.

continue_workflow_if_action_failsboolean | null

When `true`, downstream actions still run for a row even if this action fails. When `false`, the row stops at this action on failure and downstream cells stay queued. Send `null` to clear the action's own setting so it follows the sheet's `continue_on_fail` (default off). Omit to leave it unchanged. Absent in responses means the action follows the sheet.

notestring

Optional free-text note to save on the action. Same upsert behaviour as Save Action Note — overwrites any existing note. Whitespace-only values are ignored.

output_typesobject

Optional. Sets the declared type of outputs whose type is a per-action choice — today Formula's `result`. Map of output name (as Get Outputs returns it) → type: `string` (default), `number`, `boolean`, `date`, `currency`, `email`, `url`, `imageUrl` or `json`. The stored value is unchanged; the type decides which `run_if` / `filter` operators apply, and Get Outputs reports it. A condition takes its type when the condition is saved, so set the type before adding conditions on this output. Any other output name returns 400.

Example

AddActionBody example
{
  "action_id": "enrich_company_linkedin_profile",
  "after": "enrich_company_linkedin_profile_1",
  "name": "Enrich primary contact",
  "inputs": {
    "linkedin_url": "{{input.linkedin_url}}"
  },
  "run_if": null,
  "continue_workflow_if_action_fails": null,
  "note": "Skip until Phase 2 — vendor still negotiating contract terms.",
  "output_types": {
    "result": "number"
  }
}