Updates the project with the specified id.

PUT

Updates the project with the specified id.

Required Permissions: The user has to be the creator of the project or needs write permissions of the feature project-master-data.

Path parameters

projectIdstringRequired
The id of the project.

Request

This endpoint expects an object.
namestringRequired
The name of the Project. Max allowed length: 25000 characters.
isPrivatebooleanOptional
Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.
descriptionstringOptional
The project description. Max allowed length: 25000 characters.
startDatedatetimeOptional
The start date of the project.
dueDatedatetimeOptional
The due date of the project.
companyIdstringOptional
The id of the company.
timeBudgetintegerOptional
The time budget the project has, in seconds.
isBillableByDefaultbooleanOptional
Whether project times should be billable by default.
projectTypeIdstringOptional
The id of the project type of this project.
colorstringOptional
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.

Response

This endpoint returns an object
namestring
The name of the Project. Max allowed length: 25000 characters.
isPrivatebooleanOptional
Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.
descriptionstringOptional
The project description. Max allowed length: 25000 characters.
startDatedatetimeOptional
The start date of the project.
dueDatedatetimeOptional
The due date of the project.
companyIdstringOptional
The id of the company.
timeBudgetintegerOptional
The time budget the project has, in seconds.
isBillableByDefaultbooleanOptional
Whether project times should be billable by default.
projectTypeIdstringOptional
The id of the project type of this project.
colorstringOptional
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
projectStatusIdstringOptional
The id of the project status.
projectTemplateIdstringOptional
The id of the template which is used to create the project.
publicProjectTemplateIdstringOptional
The id of the public template which is used to create the project.
idstringOptional
Id of the project.
hasImagebooleanOptional
Whether the project has an image.
createdOndatetimeOptional
The date this entity was created.
createdBystringOptional
The id of the user who created this entity.
updatedOndatetimeOptional
The date this entity was last modified.
updatedBystringOptional
The id of the user who last modified this entity.
closedOndatetimeOptional
The date the project was set to closed.
closedBystringOptional
The user who closed the project.
createdByProjectTemplateIdstringOptional
The id of the template the project was created from.
projectTypeobjectOptional
projectStatusobjectOptional
companyobjectOptional
tagslist of objectsOptional
The tags for this project.
plannedDurationlongOptional
The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.
tasksCountintegerOptional
The number of all tasks related to the project.
tasksDoneCountintegerOptional
The number of all tasks in status 'done' related to the project.
memberslist of objectsOptional
The members of this project.
trackedDurationintegerOptional
The summed up duration of all time trackings for this project.
resourceVersionlongOptional
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
teamslist of objectsOptional
The teams the project is associated to.
isExternalbooleanOptional
True if this entity is coming from an external workspace (awork Connect).
Built with