Creates a new project milestone. | awork API

curl -X POST https://api.awork.com/api/v1/projectmilestones \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Internal Review",
  "color": "green",
  "projectId": "123e4567-e89b-12d3-a456-426614174000"
}'

{
  "name": "Internal Review",
  "color": "green",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "dueDate": "2022-03-01T15:00:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "project": {
    "name": "Website Design",
    "isPrivate": false,
    "description": "Sitemap, design, assets and implementation of the new online presence.",
    "startDate": "2022-03-01T00:00:00Z",
    "dueDate": "2022-05-01T00:00:00Z",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "timeBudget": 576000,
    "isBillableByDefault": true,
    "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "color": "purple",
    "deductNonBillableHours": true,
    "isProjectKeyVisible": true,
    "projectStatusId": "123e4567-e89b-12d3-a456-426614174000",
    "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "publicProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "workflowId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "projectKey": "string",
    "hasImage": true,
    "createdOn": "2024-01-15T09:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedOn": "2024-01-15T09:30:00Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "closedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdByProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "projectType": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "icon": "thumb_up",
      "isArchived": false
    },
    "projectStatus": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "description": "Work in progress",
      "type": "todo",
      "isArchived": false,
      "typeOrder": 1,
      "isExternal": true
    },
    "company": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "hasImage": true,
      "description": "A brand strategy and design agency",
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Design",
          "color": "purple",
          "entityId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    },
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "color": "purple"
      }
    ],
    "totalPlannedDurationWithHierarchy": 432000,
    "tasksCount": 12,
    "tasksDoneCount": 3,
    "members": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "Lisa",
        "lastName": "Smith",
        "hasImage": true,
        "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
        "projectRoleName": "Project Manager",
        "isResponsible": true,
        "isDeactivated": false,
        "isExternal": true
      }
    ],
    "trackedDuration": 72000,
    "customFields": [
      {
        "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
        "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
        "clientIdValue": "123e4567-e89b-12d3-a456-426614174000",
        "numberValue": 123.45,
        "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
        "selectionOption": {
          "value": "Website Design",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "purple",
          "order": 0
        },
        "textValue": "S1: Business Critical",
        "dateValue": "2024-01-15T09:30:00Z",
        "booleanValue": true
      }
    ],
    "resourceVersion": 637825154598057900,
    "teams": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Designers",
        "icon": "paintbrush",
        "color": "purple"
      }
    ],
    "isExternal": true,
    "isRetainer": true,
    "isMultiAssignmentAllowed": true,
    "plannedDuration": 432000
  },
  "createdOn": "2024-01-15T09:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2024-01-15T09:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

Required Permissions

The user must either be admin, have ‘project-planning-data:write’ permissions on the project or be the creator.

<Check title="Required Permissions" icon="key">The user must either be admin, have 'project-planning-data:write' permissions on the project or be the creator.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The model containing milestone details.

namestringRequired0-255 characters

The name of the milestone.

colorstringRequired0-14 characters

The color of the milestone.

projectIdstringRequiredformat: "uuid"

The id of the project the milestone is related to.

dueDatedatetimeOptional

The date the milestone is due.

Response

namestring0-255 characters

The name of the milestone.

colorstring0-14 characters

The color of the milestone.

projectIdstringformat: "uuid"

The id of the project the milestone is related to.

dueDatedatetime

The date the milestone is due.

idstringformat: "uuid"

projectobject

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

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

The date this entity was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

Errors

400

Bad Request Error