API ReferenceProject

Update Project

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional
The name of the Project.
descriptionstringOptional
An optional description of the Project
targetDatestringOptional
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.
folderIdstringOptional
To move this Project into a ProjectFolder, set this to the unique identifier of the ProjectFolder.
customerIdstringOptional
To assign this Project to a ProjectCustomer, set this to the unique identifier of the ProjectCustomer.
managerIdstringOptional
To assign this Project to a ProjectManager, set this to the unique identifier of the ProjectManager.
chargeCodeIdstringOptional
To set the ChargeCode for this Project, set this to the unique identifier of the ChargeCode to use for this Project.
statusIdstringOptional
To change the ProjectStatus of this Project, set this to the unique identifier of the ProjectStatus.
priorityIdstringOptional
To change the ProjectPriority of this Project, set this to the unique identifier of the ProjectPriority.
hourlyRatedoubleOptional
To change the hourly rate of this Project, set this to the new amount.
budgetdoubleOptional
To change the budget of this Project, set this to the new amount.
statusUpdatestringOptional
To update the Project's status text, set this to the new status text.

Response

This endpoint returns an object.
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.