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.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequiredformat: "uuid"
The unique identifier of the Project to update

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

All non-null fields in this object will replace previous data within the Project

namestring or nullOptional
The name of the Project.
shortNamestring or nullOptional<=7 characters
The short name of the Project.
descriptionstring or nullOptional
An optional description of the Project
targetDatestring or nullOptionalformat: "date"
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.
folderIdstring or nullOptionalformat: "uuid"
To move this Project into a ProjectFolder, set this to the unique identifier of the ProjectFolder.
customerIdstring or nullOptionalformat: "uuid"
To assign this Project to a ProjectCustomer, set this to the unique identifier of the ProjectCustomer. If set to an empty guid the Project will be unassigned from the current ProjectCustomer.
managerIdstring or nullOptionalformat: "uuid"
To assign this Project to a ProjectManager, set this to the unique identifier of the ProjectManager.
chargeCodeIdstring or nullOptionalformat: "uuid"
To set the ChargeCode for this Project, set this to the unique identifier of the ChargeCode to use for this Project.
statusIdstring or nullOptionalformat: "uuid"
To change the ProjectStatus of this Project, set this to the unique identifier of the ProjectStatus.
priorityIdstring or nullOptionalformat: "uuid"
To change the ProjectPriority of this Project, set this to the unique identifier of the ProjectPriority.
hourlyRatedouble or nullOptional
To change the hourly rate of this Project, set this to the new amount.
budgetdouble or nullOptional
To change the budget of this Project, set this to the new amount.
statusUpdatestring or nullOptional
To update the Project's status text, set this to the new status text.
favoriteboolean or nullOptional
Mark this project as favorite for the logged in user.
templateboolean or nullOptional

True if this Project is a template that will be reused as a framework for future Projects.

You can save a Project as a template and reuse it in the future for creating additional Projects. If this Project is a template, set this to true and this template will be available to choose from when creating a new Project within the application.

updatePlannedWithActualboolean or nullOptional
True if allow actual dates to update planned dates
notesstring or nullOptional
To update the project notes
externalReferenceIdstring or nullOptional
An optional external reference identifier for this Project. This value can be used to link the Project to records in external systems, such as ERP, CRM, or other integrations.

Response

Success
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.