Update Project

Update Project can be used to update Project properties. Projects are a deprecated feature.

patch/api/v4/{workspace-slug}/projects/{project-public-id}

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/projects/{project-public-id}
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

project-public-idinteger required

The unique ID of the Project.

Query parameters

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

Request body

abbreviationstring nullable

The abbreviation for the Project. Set to null to clear.

archivedboolean

Whether the Project is archived.

colorstring css-color nullable

The hex color for the Project. Set to null to clear.

days_to_thermometerinteger

The number of days before the thermometer is shown.

descriptionstring nullable

The description of the Project.

follower_idsstring[]

UUIDs of Members to set as Followers. Replaces current followers.

follower_ids_addstring[]

UUIDs of Members to add as Followers.

follower_ids_removestring[]

UUIDs of Members to remove as Followers.

namestring

The name of the Project.

show_thermometerboolean

Whether the thermometer is shown.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

No recorded changes to this operation across all 1 revision of this API.