Skip to main content
PATCH
Update Project

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required

The ID of the Project to update.

Example:

"314"

Body

application/json
name
string

The new name of the Project.

Minimum string length: 1
description
string

The new description of the Project.

status
enum<string> | null

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

Available options:
in_progress,
in_review,
completed,
null

Response

Project updated successfully.

A Project in the Scorecard system.

id
string
required

The ID of the Project.

name
string | null
required

The name of the Project.

description
string | null
required

The description of the Project.

status
enum<string> | null
required

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

Available options:
in_progress,
in_review,
completed,
null
statusUpdatedAt
string | null
required

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