API reference / CRM
Run a list's work column
Fills a work column over the list's rows, in batches, in the order they were added: every row, the rows named, or the first few to try it. Rows with a value are skipped unless redo; a cell a person filled is never changed. Answers 202 with the run (poll statusUrl), or with run null and rows 0 when there is nothing to do. With estimate, nothing runs: rows says how many it would work on.
/api/v1/lists/{id}/columns/{column}/runOther ways to call it
troopy lists run-columntroopy_run_list_columnIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
id*stringA 24-character id
column*stringAt most 40 characters
Body
application/jsonrowsarray<string>Only these rows
At most 1000 items
firstintegerOnly the first this many rows it would work on: a try
At least 1 · At most 1000
wherearray<object>Only rows that pass these filters
At most 10 items
3 properties
column*stringA column's id
At most 40 characters
op*enum<string>isis_notcontainsgtltemptynot_empty
valuestring | number | booleanWhat to compare with; none for empty and not_empty
redobooleanAlso the rows it filled before
Default false
estimatebooleanSay how many rows it would work on, and run nothing
Default false
Response
202 · application/jsondata*object2 properties
run*object | null14 properties
id*stringA 24-character id
list*stringA 24-character id
column*stringstatus*enum<string>running: poll statusUrl every few seconds
runningdonestoppedfailed
total*integerRows it works on
done*integerRows it filled
none*integerRows it found nothing for
failed*integerRows that failed
note*string | nullWhile it waits: what for, and until when
error*string | nullby*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
finishedAt*string | nullstatusUrl*stringrows*integerRows it works on, or would