Update project properties and defaults

PATCH/api/projects/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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

idstringRequiredThe project's id.

Request body

application/json · required

goalIdstring (uuid) | nullOptional
goalIdsarray<string (uuid)>Optional
namestringOptionalat least 1 character
descriptionstring | nullOptional
visibilitystringOptionalone of: "open", "private"
statusstringOptionalone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullOptional
decisionOwnerUserIdstring | nullOptionalat least 1 character
targetDatestring | nullOptional
colorstring | nullOptional
iconstring | nullOptionalone 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"
envobject<string, string | object> | nullOptional
executionWorkspacePolicyobject | nullOptional
executionWorkspacePolicy.enabledbooleanRequired
executionWorkspacePolicy.sharedWorkspaceConcurrencystringOptionalone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringOptionalone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanOptional
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullOptional
executionWorkspacePolicy.environmentIdstring (uuid) | nullOptional
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullOptional
executionWorkspacePolicy.workspaceStrategyobject | nullOptional
executionWorkspacePolicy.workspaceStrategy.typestringOptionalone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullOptional
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullOptional
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullOptional
executionWorkspacePolicy.workspaceRuntimeobject | nullOptional
executionWorkspacePolicy.branchPolicyobject | nullOptional
executionWorkspacePolicy.pullRequestPolicyobject | nullOptional
executionWorkspacePolicy.runtimePolicyobject | nullOptional
executionWorkspacePolicy.cleanupPolicyobject | nullOptional
executionWorkspacePolicy.authorizationPolicyobject | nullOptional
executionWorkspacePolicy.authorizationPolicy.trustPresetstringOptionalone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectOptional
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectOptional
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectOptional
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectOptional
archivedAtstring (date-time) | 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.

Projects