API reference / CRM
Change a list's column
Renames, resizes, hides or moves a column, or changes a select's options: send them all, existing ones with their id (their current name). A renamed option's values follow it; a removed one's are emptied.
/api/v1/lists/{id}/columns/{column}Other ways to call it
troopy lists update-columntroopy_update_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/jsonnamestringAt least 1 characters · At most 60 characters
widthintegerAt least 60 · At most 800
hiddenbooleanpositionintegerIts place among the columns, from 0
At least 0 · At most 99
optionsarray<object>At most 50 items
3 properties
idstringAn existing option's name, to keep or rename it; leave it out to add one
At most 40 characters
name*stringAt least 1 characters · At most 40 characters
colorenum<string>stoneskymintsandrosepeachcyanorange
workobjectA work column's new ask, or what it finds; it stays a work column of the same kind
3 properties
kind*"ai"ask*stringWhat to work out for each row, in plain words
At least 1 characters · At most 1000 characters
readbooleanRead each row's website (its home, contact, about and team pages) first
Default false
Response
200 · application/jsondata*object8 properties
id*stringA standard column's field (name, email, title...) or c1, c2... for the list's own
name*stringtype*enum<string>textnumberdateselectmulti_selecturlcheckboxemailphonelong_text
options*array<object>3 properties
id*stringIts name: a select's value is its option's name
name*stringcolor*enum<string>stoneskymintsandrosepeachcyanorange
width*integerhidden*booleanstandard*booleanThe record's own field, the same on every list it is on; it can be hidden, not deleted
work*object | nullWhat it works out when it runs, for a work column; null for the rest
3 properties
kind*"ai"ask*stringWhat to work out for each row, in plain words
At least 1 characters · At most 1000 characters
read*booleanRead each row's website (its home, contact, about and team pages) first
Default false