API reference / Tasks and projects
Change a project
Changes any of a project's fields; send only those to change, and the version you read to refuse the change if someone edited it since.
/api/v1/projects/{id}Other ways to call it
troopy projects updatetroopy_update_projectIdempotency-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
Body
application/jsonnamestringAt least 1 characters · At most 80 characters
summarystringAt most 280 characters
descriptionstringAt most 20000 characters
iconstringA lucide icon name, like rocket
statusenum<string>plannedactivepauseddonecanceled
priorityenum<string>noneurgenthighmediumlow
leadstring | nullA teammate's handle (like writer), a person's user id, me for yourself, or null for nobody
startAtstring | nulltargetAtstring | nullmilestonesarray<object>All its milestones, in order: one left out is removed, and its tasks leave it
At most 20 items
3 properties
idstringKeeps an existing milestone; leave out for a new one
name*stringAt least 1 characters · At most 80 characters
targetAtstring | nullversionintegerResponse
200 · application/jsondata*object19 properties
id*stringA 24-character id
name*stringsummary*stringdescription*stringicon*stringstatus*enum<string>plannedactivepauseddonecanceled
priority*enum<string>noneurgenthighmediumlow
lead*object | null3 properties
type*enum<string>agentperson
id*stringname*stringstartAt*string | nulltargetAt*string | nulltasks*objectIts tasks, canceled ones left out
4 properties
total*integerdone*integeropen*integerneedsYou*integerprogress*integerPercent of its tasks done
milestones*array<object>Steps on the way, in order, each with its tasks (canceled ones left out)
5 properties
id*stringA 24-character id
name*stringtargetAt*string | nulltasks*object2 properties
total*integerdone*integerprogress*integerhealth*enum<string> | nullHow it's going, from its latest status update
on_trackat_riskoff_track
lastUpdateAt*string | nullcreatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
version*integer