SyncSourceBody

Body for Sync Source to Workflow. Maps workflow inputs to source fields and (by default) backfills existing rows.

Properties

workflow_idstring <uuid>required

UUID of the destination workflow.

field_mappingobjectrequired

Map of workflow input reference → source field, e.g. `{ "input.email": "email", "input.first_name": "firstname" }`. Keys are `input.<field>` references from the workflow's inputs; values are source field names. Keys are CASE-SENSITIVE and must be the exact lowercase snake_case form returned by List Inputs (the input's `reference` without the `{{ }}` braces) — e.g. `input.first_name`, not `Input.First_Name` or `input.firstName`. Surrounding `{{ }}` is tolerated; case/spelling variants are not, and return 400 `unknown input`.

push_existingboolean

Whether to backfill the workflow with the source's current rows. Defaults to true.

runstringdeprecated

Deprecated and ignored (reported in `warnings[]`). Whether landed rows execute is the sheet's `auto_run` toggle — set it with Update Sheet before syncing. Will be rejected in a future release.

Example

SyncSourceBody example

{
  "workflow_id": "00000000-0000-0000-0000-000000000000",
  "field_mapping": {},
  "push_existing": false,
  "run": "string"
}