Project

Update Project

PUT

Update an existing Project and replace the values of fields specified.

A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks represent individual items of work that team members must complete. The sum total of Tasks within a Project represents the work to be completed for that Project.

Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset.

Path parameters

projectIdstringRequired
The unique identifier of the Project to update

Request

This endpoint expects an object.
name
stringOptional
The name of the Project.
description
stringOptional
An optional description of the Project
targetDate
stringOptional
The target planned completion date for this Project, or null if one has not been selected. This value can be updated in the Project Settings page or the Portfolio Project page within the application.
folderId
stringOptional
To move this Project into a ProjectFolder, set this to the unique identifier of the ProjectFolder.
customerId
stringOptional
To assign this Project to a ProjectCustomer, set this to the unique identifier of the ProjectCustomer.
managerId
stringOptional
To assign this Project to a ProjectManager, set this to the unique identifier of the ProjectManager.
chargeCodeId
stringOptional
To set the ChargeCode for this Project, set this to the unique identifier of the ChargeCode to use for this Project.
statusId
stringOptional
To change the ProjectStatus of this Project, set this to the unique identifier of the ProjectStatus.
priorityId
stringOptional
To change the ProjectPriority of this Project, set this to the unique identifier of the ProjectPriority.
hourlyRate
doubleOptional
To change the hourly rate of this Project, set this to the new amount.
budget
doubleOptional
To change the budget of this Project, set this to the new amount.
statusUpdate
stringOptional
To update the Project's status text, set this to the new status text.
favorite
booleanOptional
Mark this project as favorite for the logged in user.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
PUT
1curl -X PUT /api/data/projects/projectId \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200
Updated
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue"
12}