API ReferenceProject

Create Project

Create a new project based on the details provided. 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.

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
folderIdstringOptional
The unique identifier of the folder of this project, or null if not assigned.
memberslist of objectsOptional
If you wish to grant access to this Project to a selected list of people during creation, provide a list of ProjectMembers here. If you do not specify anyone, this Project will be available to only yourself.
customerIdstringOptional
The unique identifier of the customer for this project, or null if not customer specific
managerIdstringOptional
The unique identifier of the manager of this project, or null if not assigned.
chargeCodeIdstringOptional
The unique identifier of the ChargeCode for this Project, if one has been selected.
statusIdstringOptional
The ProjectStatus chosen for this Project, if one has been selected.
priorityIdstringOptional
The ProjectPriority level of this Project, if one has been selected.
hourlyRatedoubleOptional
The default hourly rate for work on this Project. This rate will be used if an assignee working on this Project does not have an hourly rate configured in their profile.
budgetdoubleOptional
The proposed budget for this Project.
statusUpdatestringOptional
Contains an optional status update for Projects that can be used to summarize the status of multiple Projects at a glance. You can edit the StatusUpdate field on the Portfolio page of the application.
templatebooleanOptional

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.

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.
dataobject or null
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.