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.

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Request

Information about the Project you wish to create

budgetdoubleOptional

The proposed budget for this Project.

chargeCodeIdstringOptionalformat: "uuid"

The unique identifier of the ChargeCode for this Project, if one has been selected.

customerIdstringOptionalformat: "uuid"

The unique identifier of the customer for this project, or null if not customer specific

descriptionstringOptional

An optional description of the Project

favoritebooleanOptional

True if this Project is marked as favorite for current user

folderIdstringOptionalformat: "uuid"

The unique identifier of the folder of this project, or null if not assigned.

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.

managerIdstringOptionalformat: "uuid"

The unique identifier of the manager of this project, or null if not assigned.

namestringOptional

The name of the Project.

priorityIdstringOptionalformat: "uuid"

The ProjectPriority level of this Project, if one has been selected.

projectAccessobjectOptional

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.

statusIdstringOptionalformat: "uuid"

The ProjectStatus chosen for this Project, if one has been selected.

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.

targetDatestringOptionalformat: "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.

taskStatusCreatelist of objectsOptional

Create default task status upfront

templateIdstringOptionalformat: "uuid"

When creating a Project, you can optionally specify a Template to use to construct the Project using a collection of pre-designed Tasks.

Specifying a value in the TemplateId field will copy default settings for Tasks from your template Project into the newly created Project.

This field does not support custom templates. You must choose from a list of ProjectManager-supplied templates.

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeobjectOptional

The HTTP code of the response.

dataobjectOptional

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.