Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Tasks and projects

Post a project status update

Says how a project is going (on_track, at_risk or off_track) and why, in markdown: what moved, what's stuck, what's next. Its health shows on the project until the next update.

post/api/v1/projects/{id}/updates

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy projects post-update
MCP tooltroopy_create_project_update
Rate limit30 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Path parameters

id*string

A 24-character id

Body

application/json
health*enum<string>

on_trackat_riskoff_track

body*string

Markdown: what moved, what's stuck, what's next

At least 1 characters · At most 5000 characters

Response

201 · application/json
data*object
6 properties
id*string

A 24-character id

projectId*string

A 24-character id

health*enum<string>

on_trackat_riskoff_track

body*string

Markdown: what moved, what's stuck, what's next

by*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
createdAt*string

ISO 8601 date and time

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.