Creates a new project milestone.

POST

1 curl -X POST https://api.awork.com/api/v1/projectmilestones \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Internal Review",
6   "color": "green",
7   "dueDate": "2022-03-01T15:00:00Z",
8   "projectId": "123e4567-e89b-12d3-a456-426614174000"
9 }'

Play

200Successful

1 {
2   "name": "Internal Review",
3   "color": "green",
4   "dueDate": "2022-03-01T15:00:00Z",
5   "projectId": "123e4567-e89b-12d3-a456-426614174000",
6   "id": "123e4567-e89b-12d3-a456-426614174000",
7   "project": {
8     "name": "Website Design",
9     "isPrivate": false,
10     "description": "Sitemap, design, assets and implementation of the new online presence.",
11     "startDate": "2022-03-01T00:00:00Z",
12     "dueDate": "2022-05-01T00:00:00Z",
13     "companyId": "123e4567-e89b-12d3-a456-426614174000",
14     "timeBudget": 576000,
15     "isBillableByDefault": true,
16     "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
17     "color": "purple",
18     "deductNonBillableHours": false,
19     "projectStatusId": "123e4567-e89b-12d3-a456-426614174000",
20     "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
21     "publicProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
22     "id": "123e4567-e89b-12d3-a456-426614174000",
23     "hasImage": true,
24     "createdOn": "createdOn",
25     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
26     "updatedOn": "updatedOn",
27     "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
28     "closedOn": null,
29     "closedBy": "123e4567-e89b-12d3-a456-426614174000",
30     "createdByProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
31     "projectType": {
32       "id": "123e4567-e89b-12d3-a456-426614174000",
33       "name": null,
34       "icon": null,
35       "isArchived": false
36     },
37     "projectStatus": {
38       "id": "123e4567-e89b-12d3-a456-426614174000",
39       "name": null,
40       "description": null,
41       "type": null,
42       "isArchived": false,
43       "typeOrder": 1,
44       "isExternal": true
45     },
46     "company": {
47       "id": "123e4567-e89b-12d3-a456-426614174000",
48       "name": null,
49       "hasImage": true,
50       "description": "A brand strategy and design agency",
51       "tags": [
52         {
53           "id": "123e4567-e89b-12d3-a456-426614174000",
54           "name": null,
55           "color": null,
56           "entityId": "123e4567-e89b-12d3-a456-426614174000"
57         }
58       ]
59     },
60     "tags": [
61       {
62         "id": "123e4567-e89b-12d3-a456-426614174000",
63         "name": "Design",
64         "color": "purple"
65       }
66     ],
67     "plannedDuration": 432000,
68     "tasksCount": 12,
69     "tasksDoneCount": 3,
70     "members": [
71       {
72         "id": "123e4567-e89b-12d3-a456-426614174000",
73         "userId": "123e4567-e89b-12d3-a456-426614174000",
74         "firstName": "Lisa",
75         "lastName": "Smith",
76         "hasImage": true,
77         "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
78         "projectRoleName": "Project Manager",
79         "isResponsible": true,
80         "isDeactivated": false,
81         "isExternal": true
82       }
83     ],
84     "trackedDuration": 72000,
85     "resourceVersion": 637825154598057900,
86     "teams": [
87       {
88         "id": "123e4567-e89b-12d3-a456-426614174000",
89         "name": "Designers",
90         "icon": "paintbrush",
91         "color": "purple"
92       }
93     ],
94     "isExternal": true,
95     "isRetainer": false
96   },
97   "createdOn": "createdOn",
98   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
99   "updatedOn": "updatedOn",
100   "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
101 }

The user needs ‘write’ permissions of feature ‘project-planning-data’ to get the data.

Required Permissions

Any authenticated user.

Request

This endpoint expects an object.

namestring or nullOptional>=0 characters<=255 characters

The name of the milestone.

colorstring or nullOptional>=0 characters<=14 characters

The color of the milestone.

dueDatedatetimeOptional

The date the milestone is due.

projectIdUUIDOptional

The id of the project the milestone is related to.

Response

namestring or nullOptional>=0 characters<=255 characters

The name of the milestone.

colorstring or nullOptional>=0 characters<=14 characters

The color of the milestone.

dueDatedatetimeOptional

The date the milestone is due.

projectIdUUIDOptional

The id of the project the milestone is related to.

idUUIDOptional

projectobjectOptional

/// This class contains all information to handle projects.

createdOndatetimeOptional

The date this entity was created.

createdByUUIDOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedByUUIDOptional

The id of the user who last modified this entity.

Required Permissions

Headers

Request

Response