Skip to content
My Docs

Updates an existing project

PUT
/api/v1/Project/{projectId}

Sample request:

PUT /api/v1/Project/{projectId}
{
    "name": "Updated Name",
    "description": "Updated description",
    "startDate": "2024-02-01",
    "endDate": "2024-12-31",
    "status": "InProgress"
}

Required permissions:

  • Project Owner access level, or
  • Admin access

Authorizations

Parameters

Path Parameters

projectId
required
string format: uuid

The unique identifier of the project to update

Request Body

Updated project details

object
name
string
nullable >= 3 characters <= 20 characters
description
string
nullable >= 3 characters <= 100 characters
startDate
string format: date
endDate
string format: date
status
integer format: int32

Responses

200

Project successfully updated

object
id
string format: uuid
workspaceId
string format: uuid
name
string
nullable
description
string
nullable
startDate
string format: date-time
nullable
endDate
string format: date-time
nullable
status
integer format: int32
createdDate
string format: date-time
members
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
workspaceMemberId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time
workspaceMember
object
id
string format: uuid
workspaceId
string format: uuid
userId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time
lists
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
name
string
nullable
position
integer format: int32
createdDate
string format: date-time
tasks
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
listId
string format: uuid
name
string
nullable
description
string
nullable
priority
integer format: int32
status
integer format: int32
deadline
string format: date-time
nullable
createdDate
string format: date-time
assignees
Array<object>
nullable
object
id
string format: uuid
taskId
string format: uuid
userId
string format: uuid
assignedDate
string format: date-time
user
object
id
string format: uuid
username
string
nullable
name
string
nullable
email
string
nullable
createdDate
string format: date-time
accessLevel
integer format: int32
comments
Array<object>
nullable
object
id
string format: uuid
taskId
string format: uuid
userId
string format: uuid
content
required
string
nullable
createdDate
string format: date-time
user
object
id
string format: uuid
username
string
nullable
name
string
nullable
email
string
nullable
createdDate
string format: date-time
accessLevel
integer format: int32
list
object recursive
project
object recursive

400

Invalid update data or user ID is null

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

403

Insufficient permissions to update project

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

404

Project not found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties