Update a work product
PATCH
/api/work-products/{id}Personal API keyAgent API keyConsole session
Update a work product.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
idstringRequiredThe work product's id.
Request body
application/json · required
projectIdstring (uuid) | nullOptional
executionWorkspaceIdstring (uuid) | nullOptional
runtimeServiceIdstring (uuid) | nullOptional
typestringOptional
one of: "preview_url", "runtime_service", "pull_request", "branch", "commit", "artifact", "document"providerstringOptional
at least 1 characterexternalIdstring | nullOptional
titlestringOptional
at least 1 characterurlstring (uri) | nullOptional
statusstringOptional
one of: "active", "ready_for_review", "approved", "changes_requested", "merged", "closed", "failed", "archived", "draft"reviewStatestringOptional
one of: "none", "needs_board_review", "approved", "changes_requested"isPrimarybooleanOptional
healthStatusstringOptional
one of: "unknown", "healthy", "unhealthy"summarystring | nullOptional
metadataobject | nullOptional
metadata.resourceRefobject | nullOptional
metadata.resourceRef.kindstringRequired
one of: "workspace_file"metadata.resourceRef.issueIdstring (uuid)Optional
metadata.resourceRef.projectIdstring (uuid)Optional
metadata.resourceRef.projectNamestringOptional
at least 1 charactermetadata.resourceRef.workspaceKindstringRequired
one of: "execution_workspace", "project_workspace"metadata.resourceRef.workspaceIdstring (uuid)Required
metadata.resourceRef.relativePathstringRequired
at least 1 charactermetadata.resourceRef.lineinteger | nullOptional
> 0metadata.resourceRef.columninteger | nullOptional
> 0metadata.resourceRef.displayPathstringRequired
at least 1 charactercreatedByRunIdstring (uuid) | nullOptional
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.