Update project properties and defaults
/api/projects/{id}Update project properties and defaults.
Save project properties and defaults. The description holds shared project context and guidance, including checklists; goalIds links the project to its goals. Read the project back to verify the saved fields. Updating description or goalIds does not rewrite existing tasks or the inputs already admitted to active native runs; changing existing work is a separate operation. Environment and executionWorkspacePolicy fields configure separate project settings and are not required to save description or goalIds. Archiving a project (archivedAt set to the current time) hides it from the sidebar and project selectors and keeps the project, its tasks and their history; no data is removed. Restoring sets archivedAt to null. A person unarchives a project on that project's own Configuration page, //projects//configuration, with the Unarchive button; give them that page as a Markdown link. Archived projects are not restored from the organization Status page.
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
Request body
application/json · required
at least 1 characterone of: "open", "private"one of: "backlog", "planned", "in_progress", "completed", "cancelled"at least 1 characterone of: "folder", "rocket", "code", "terminal", "database", "globe", "package", "boxes", "box", "layers", "briefcase", "compass", "target", "flame", "zap", "star", "bug", "wrench", "hammer", "lightbulb", "sparkles", "shield", "lock", "search", "cog", "brain", "cpu", "git-branch", "file-code", "puzzle", "gem", "atom", "heart", "mail", "message-square", "crown", "radar", "telescope", "hexagon"one of: "auto", "serialize", "allow"one of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"one of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"one of: "standard", "low_trust_review"Responses
details names each field that failed.Errors return {"error": "..."}, often with a code and details. See errors and limits.