POST api/progression/milestone/{roleId}/add

Add a milestone to a role.

Request Information

URI Parameters

Name	Description	Type	Additional information
roleId	Id of the role to add the milestone to.	integer	Required

Body Parameters

The milestone to add.

AddProgressionMilestoneDataContract

Name	Type	Additional information
Name	string	None.
MilestoneStatus	EnumDataContract	None.
MilestoneLeaseType	EnumDataContract	None.
MilestoneRoleType	EnumDataContract	None.
MilestoneCategory	EnumDataContract	None.
TargetDate	date	None.
OwningNegotiator	NegotiatorDataContract	None.
Id	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": "2025-10-26T06:52:52.739995Z",
  "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": "2025-10-26T06:52:52.739995Z",
    "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

ProgressionMilestoneDataContract

Name	Type	Additional information
Name	string	None.
MilestoneStatus	EnumDataContract	None.
MilestoneLeaseType	EnumDataContract	None.
MilestoneRoleType	EnumDataContract	None.
MilestoneCategory	EnumDataContract	None.
TargetDate	date	None.
CompletedDate	date	None.
CompletedBy	TeamDataContract	None.
OwningTeam	TeamDataContract	None.
OwningNegotiator	NegotiatorDataContract	None.
Documents	Collection of DocumentDataContract	None.
Contacts	Collection of ProgressionContactDataContract	None.
Notes	Collection of EventDataContract	None.
Order	integer	None.
Id	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.