> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scorecard.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Project

> Update a Project's name, description, or review status. Changing `status` requires an organization admin: an organization API key, or a token belonging to an admin. Keys and tokens scoped to an individual member receive a 403. `statusUpdatedAt` moves only when the status actually changes.



## OpenAPI

````yaml patch /projects/{projectId}
openapi: 3.1.0
info:
  title: Scorecard API
  description: REST API for Scorecard
  version: 1.0.0
servers:
  - url: https://api2.scorecard.io/api/v2
security:
  - ApiKeyAuth: []
paths:
  /projects/{projectId}:
    patch:
      summary: Update Project
      description: >-
        Update a Project's name, description, or review status. Changing
        `status` requires an organization admin: an organization API key, or a
        token belonging to an admin. Keys and tokens scoped to an individual
        member receive a 403. `statusUpdatedAt` moves only when the status
        actually changes.
      operationId: updateProject
      parameters:
        - in: path
          name: projectId
          description: The ID of the Project to update.
          schema:
            type: string
            example: '314'
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  description: The new name of the Project.
                description:
                  type: string
                  description: The new description of the Project.
                status:
                  type:
                    - string
                    - 'null'
                  enum:
                    - in_progress
                    - in_review
                    - completed
                    - null
                  description: >-
                    The new review status of the Project. Only organization
                    admins can change it. Pass `null` to stop tracking a status.
            examples:
              Mark a project completed:
                value:
                  status: completed
                summary: Mark a project completed
                description: Mark the Project's review round as completed.
      responses:
        '200':
          description: Project updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
              examples:
                Updated project:
                  value:
                    id: '314'
                    name: My Project
                    description: This is a test project
                    status: completed
                    statusUpdatedAt: '2025-01-20T16:45:00.000Z'
                  summary: Updated project
                  description: Response after marking the Project as completed.
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '403':
          description: >-
            Error indicating that the caller is authenticated but not allowed to
            perform this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Permission denied:
                  value:
                    code: UNAUTHORIZED
                    message: Only organization admins can change a project's status.
                    details: {}
                  summary: Permission denied
                  description: >-
                    Error returned when a caller who isn't an organization admin
                    tries to change `status`.
        '500':
          $ref: '#/components/responses/ServiceError'
components:
  schemas:
    Project:
      type: object
      properties:
        id:
          type: string
          description: The ID of the Project.
        name:
          type:
            - string
            - 'null'
          description: The name of the Project.
        description:
          type:
            - string
            - 'null'
          description: The description of the Project.
        status:
          type:
            - string
            - 'null'
          enum:
            - in_progress
            - in_review
            - completed
            - null
          description: >-
            The review status of the Project, set by an organization admin.
            `null` if the Project doesn't track a status.
        statusUpdatedAt:
          type:
            - string
            - 'null'
          description: >-
            The ISO 8601 timestamp when `status` last changed. `null` if a
            status has never been set.
      required:
        - id
        - name
        - description
        - status
        - statusUpdatedAt
      description: A Project in the Scorecard system.
    ApiError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
          x-stainless-any: true
      required:
        - code
        - message
        - details
      description: An API error.
  responses:
    UnauthenticatedError:
      description: Error indicating that the request is not authenticated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            Authentication failure:
              value:
                code: UNAUTHORIZED
                message: Invalid or missing authentication token
                details: {}
              summary: Authentication failure
              description: >-
                Error returned when authentication credentials are invalid or
                missing.
    ServiceError:
      description: >-
        An internal service error indicating an issue with the Scorecard
        service.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            Internal error:
              value:
                code: INTERNAL_ERROR
                message: An unexpected error occurred while processing your request.
                details: {}
              summary: Internal error
              description: Generic error when an unexpected internal issue occurs.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: starts with ak_

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.