PUT api/progression/milestones/add?purchasingRoleId={purchasingRoleId}

Save a new milestone Processes this progression API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
purchasingRoleId	The purchasing role ID	integer	Required

Body Parameters

Collection of milestone orders

AddProgressionMilestoneDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
MilestoneStatus	The milestone status value.	EnumDataContract	None.
MilestoneLeaseType	The milestone lease type value.	EnumDataContract	None.
MilestoneRoleType	The milestone role type value.	EnumDataContract	None.
MilestoneCategory	The milestone category value.	EnumDataContract	None.
TargetDate	The target date, expressed as a date and time.	date	None.
OwningNegotiator	The owning negotiator value.	NegotiatorDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "MilestoneStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "MilestoneLeaseType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "MilestoneRoleType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "MilestoneCategory": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TargetDate": "2026-07-23T08:20:02.9562988Z",
  "OwningNegotiator": {
    "AgencyId": 1,
    "Initials": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "ContactName": "sample string 6",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 7",
    "CurrentStatus": 8,
    "ContactItems": [
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      }
    ],
    "ClaimedTask": {
      "ToDoTitle": "sample string 1",
      "ToDoDescription": "sample string 2",
      "ToDoId": 3,
      "ToDoType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 4
    },
    "Biography": "sample string 9",
    "SystemStatus": "sample string 10",
    "Permissions": [
      {
        "Name": "sample string 1",
        "Id": 2
      },
      {
        "Name": "sample string 1",
        "Id": 2
      }
    ],
    "CreatedDate": "2026-07-23T08:20:02.9562988Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 12
  },
  "Id": 2
}

Response Information

Resource Description

The response returned after the operation completes.

ProgressionMilestoneDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
MilestoneStatus	The milestone status value.	EnumDataContract	None.
MilestoneLeaseType	The milestone lease type value.	EnumDataContract	None.
MilestoneRoleType	The milestone role type value.	EnumDataContract	None.
MilestoneCategory	The milestone category value.	EnumDataContract	None.
TargetDate	The target date, expressed as a date and time.	date	None.
CompletedDate	The completed date, expressed as a date and time.	date	None.
CompletedBy	The completed by value.	TeamDataContract	None.
OwningTeam	The owning team value.	TeamDataContract	None.
OwningNegotiator	The owning negotiator value.	NegotiatorDataContract	None.
Documents	The collection of documents.	Collection of DocumentDataContract	None.
Contacts	The collection of contacts.	Collection of ProgressionContactDataContract	None.
Notes	The collection of notes.	Collection of EventDataContract	None.
Order	The order value.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.