--- title: "Update a project" canonical: "https://admiral.io/docs/api/projects/ProjectAPI_UpdateProject" --- # Update a project `PATCH https://api.admiral.io/v1/projects/{project.id}` Scope: `project:write` ### Path parameters - `project.id` (string, required): Unique identifier for the project. Pattern `^prj-[0-9a-z]+$`. Read-only. ### Request body - `update_mask` (FieldMask): The set of fields to update. Optional; if omitted, all populated fields are updated. Pass `*` for full replacement. Supported fields: `name`, `description`, `labels`. ### Response 200 Success - `project` (Project): The updated project. - `id` (string): Unique identifier for the project. Pattern `^prj-[0-9a-z]+$`. Read-only. - `name` (string): URL-safe, human-readable identifier (e.g., "inventory-api"). Unique within the organization. Lowercase alphanumeric and hyphens only, must start with a letter and end with an alphanumeric character (1-63 chars). Pattern `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. Length 1 to 63. - `description` (string): Optional longer-form description of the project's purpose (e.g., "Core inventory service tracking warehouse stock and fulfillment"). Length at most 1024. - `labels` (map of string to string): Arbitrary key-value labels for organizing and filtering projects (e.g., `{"team": "logistics", "tier": "critical"}`). - `created_by` (ActorRef): The user or agent who created this project (server-populated from token). Read-only. - `id` (string): The actor's typed id: a `usr-` user id or an `sa-` service account id. - `display_name` (string): Human-readable name (e.g., "John Smith", "deploy-bot"). - `email` (string): Email address (empty for non-human actors). - `created_at` (Timestamp): When the project was created. Read-only. - `updated_at` (Timestamp): When the project was last updated. Read-only.