Projects

Update a project

patch/api/workspaces/{workspaceId}/projects/{projectId}

Request

  • Base URL: https://hiveship.app/api
  • URL: https://hiveship.app/api/api/workspaces/{workspaceId}/projects/{projectId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie hiveship_access

Path parameters

workspaceIdstring required
projectIdstring required

Request body

namestring
descriptionstring
status'BACKLOG' | 'PLANNED' | 'IN_PROGRESS' | 'PAUSED' | 'COMPLETED' | 'CANCELLED' | 'ACTIVE' | 'ARCHIVED'
health'ON_TRACK' | 'AT_RISK' | 'OFF_TRACK' nullable
leadIdstring cuid nullable
startDatestring date-time nullable
targetDatestring date-time nullable
overviewstring nullable

Response

Project updated

successboolean required

Changes

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