Project

Create Project

POST

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.

Request

This endpoint expects an object.
name
stringOptional
The name of the Project.
description
stringOptional
An optional description of the Project
folderId
stringOptional
The unique identifier of the folder of this project, or null if not assigned.
projectAccess
objectOptional
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.
customerId
stringOptional
The unique identifier of the customer for this project, or null if not customer specific
managerId
stringOptional
The unique identifier of the manager of this project, or null if not assigned.
chargeCodeId
stringOptional
The unique identifier of the ChargeCode for this Project, if one has been selected.
statusId
stringOptional
The ProjectStatus chosen for this Project, if one has been selected.
priorityId
stringOptional
The ProjectPriority level of this Project, if one has been selected.
hourlyRate
doubleOptional
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.
budget
doubleOptional
The proposed budget for this Project.
statusUpdate
stringOptional
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.
template
booleanOptional

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.

templateId
stringOptional
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.
targetDate
stringOptional
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.
favorite
booleanOptional
True if this Project is marked as favorite for current user

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
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.
POST
$curl -X POST /api/data/projects \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "id": "id",
14    "name": "name",
15    "description": "description",
16    "shortCode": "shortCode",
17    "shortId": "shortId",
18    "folder": {
19      "id": "id",
20      "name": "name"
21    },
22    "status": {
23      "id": "id",
24      "name": "name",
25      "isDeleted": true
26    },
27    "startDate": "startDate",
28    "endDate": "endDate",
29    "targetDate": "targetDate",
30    "plannedStartDate": "plannedStartDate",
31    "plannedFinishDate": "plannedFinishDate",
32    "actualStartDate": "actualStartDate",
33    "actualFinishDate": "actualFinishDate",
34    "priority": {
35      "id": "id",
36      "name": "name"
37    },
38    "chargeCode": {
39      "id": "id",
40      "name": "name"
41    },
42    "manager": {
43      "id": "id",
44      "name": "name",
45      "initials": "initials",
46      "avatarUrl": "avatarUrl"
47    },
48    "customer": {
49      "id": "id",
50      "name": "name"
51    },
52    "budget": 1.1,
53    "hourlyRate": 1.1,
54    "statusUpdate": "statusUpdate",
55    "modifyDate": "2024-01-15T09:30:00Z",
56    "createDate": "2024-01-15T09:30:00Z",
57    "isTemplate": true,
58    "favorite": true,
59    "creationTemplateId": "creationTemplateId",
60    "members": [
61      {}
62    ],
63    "fields": {
64      "fields": {
65        "key": "value"
66      }
67    },
68    "fieldValues": [
69      {}
70    ],
71    "files": [
72      {}
73    ]
74  }
75}
Built with