Update Workflow Step Output
Save a sample output for a step in the workflow's draft without running it, as Edit Step Output in the editor does. Later steps learn its fields and their tests read it, so you can build and test what comes after a step whose run has side effects. It replaces the saved sample. A Loop takes none of its own (LOOP_OUTPUT_FOLLOWS_SOURCE): its sample is the first record of the step it loops over, so set that step's. Saving it changes the draft's revision: use meta.revision on your next change.
Path
The workflow's id, from List Workflows.
The step's id, from List Workflow Steps or Get Workflow Definition.
Headers
Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.
Body
The sample records.
The sample: an array of records, as the step would answer them.
Response fields
statusstringsucceeded or failed: how the run that saved the sample ended (a sample set by hand counts as succeeded). none: the step has no sample yet.
succeededfailednone
outputobjectThe first records of the output (a JSON array as the step answered it), capped at 200 records and about 60 KB. Empty when there is no sample.
totalnumberHow many records the output had in all. Null when there is no sample.
truncatedbooleanTrue when output holds fewer records than total: the rest were left out of the sample, not lost. Later steps still learn their fields from the records kept.
truncatedBystringWhy output stopped short of total. Null unless truncated is true.
recordsIt reached the 200-record cap.sizeIts records reached about 60 KB first, so it keeps fewer than 200.
outputFieldsarray of objectsThe fields of the output records, learned from the sample and offered to later steps.
keystringThe field's path in each record: dotted, with [] marking an array (lines[].sku). Reference it as {{ steps.<stepId>.output[0].<key> }}.
typestringIts type as seen in the sample: string, number, boolean, object, date, a type with [] for an array, or mixed.
errorobjectWhy the run failed. Null unless status is failed.
codestringThe runtime's error code (ARGUMENTS_MISSING, 401_UNAUTHORIZED, DEFAULT, ...).
messagestringWhat the code means, for a person. What the app answered, if anything, is in output.
statusnumberThe HTTP status the app answered, when it answered one.
savedOndateWhen the sample was saved. Null when there is none.
revisionstringThe draft's revision after the sample was saved (a sample is part of the step): send it in If-Match on your next change to the draft.