SCscorecard-ai

Update Project

Changed on

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.

patch/projects/{projectId}

Request

  • Base URL
    https://api2.scorecard.io/api/v2
  • Auth
    HTTP bearer

Path parameters

projectIdstring required
Example:314

The ID of the Project to update.

Request body

namestring

The new name of the Project.

descriptionstring

The new description of the Project.

status'in_progress' | 'in_review' | 'completed' | 'null' nullable

The new review status of the Project. Only organization admins can change it. Pass null to stop tracking a status.

Response

Project updated successfully.

idstring required

The ID of the Project.

namestring nullable required

The name of the Project.

descriptionstring nullable required

The description of the Project.

status'in_progress' | 'in_review' | 'completed' | 'null' nullable required

The review status of the Project, set by an organization admin. null if the Project doesn't track a status.

statusUpdatedAtstring nullable required

The ISO 8601 timestamp when status last changed. null if a status has never been set.

Changes