POST api/progression/sales/complete
Completes a sales role
Request Information
URI Parameters
None.
Body Parameters
Details of the completion
CompleteCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| RoleId | integer |
None. |
|
| CompletionDateTime | date |
None. |
|
| TakeOffMarket | boolean |
None. |
|
| Note | string |
None. |
|
| NegotiatorIds | Collection of integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"RoleId": 1,
"CompletionDateTime": "2025-07-31T06:58:59.9205735Z",
"TakeOffMarket": true,
"Note": "sample string 3",
"NegotiatorIds": [
1,
2
]
}
Response Information
Resource Description
CompletedDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| RoleType | EnumDataContract |
None. |
|
| Team | EventTeamDataContract |
None. |
|
| Notes | Collection of EventNoteCommandDataContract |
None. |
|
| Documents | Collection of DocumentDataContract |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| DateTime | date |
None. |
|
| EventCategory | EnumDataContract |
None. |
|
| EventType | EnumDataContract |
None. |
|
| EventStatus | EnumDataContract |
None. |
|
| Negotiators | Collection of ListNegotiatorDataContract |
None. |
|
| BranchId | integer |
None. |
|
| OwningTeamId | integer |
None. |
|
| TeamAccessType | string |
None. |
|
| CustomFields | Collection of CustomFieldGroupWithValuesDataContract |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedBy | CreatedByDataContract |
None. |
|
| Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Team": {
"Name": "sample string 1",
"CreatedDate": "2025-07-31T06:58:59.9205735Z",
"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": 3
},
"Notes": [
{
"Note": "sample string 1",
"DateAdded": "2025-07-31T06:58:59.9205735Z",
"NegotiatorId": 1,
"NegotiatorEmail": {
"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
},
"NegotiatorName": "sample string 2",
"Id": 3
},
{
"Note": "sample string 1",
"DateAdded": "2025-07-31T06:58:59.9205735Z",
"NegotiatorId": 1,
"NegotiatorEmail": {
"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
},
"NegotiatorName": "sample string 2",
"Id": 3
}
],
"Documents": [
{
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2025-07-31T06:58:59.9205735Z",
"FileStream": null,
"Tags": [
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
},
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
}
],
"ApprovalStatus": {
"Status": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Reason": "sample string 1",
"LastUpdatedBy": {
"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
},
"CreatedDate": "2025-07-31T06:58:59.9205735Z",
"LastUpdated": "2025-07-31T06:58:59.9205735Z",
"Id": 4
},
"DocumentType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DocumentSubType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FileName": "sample string 3",
"ContentType": "sample string 4",
"FileExtension": "sample string 5",
"Description": "sample string 6",
"FileSize": "sample string 7",
"CreatedDate": "2025-07-31T06:58:59.9205735Z",
"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": 9
},
{
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2025-07-31T06:58:59.9205735Z",
"FileStream": null,
"Tags": [
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
},
{
"Name": "sample string 1",
"SystemStatusName": "sample string 2",
"TagType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
}
],
"ApprovalStatus": {
"Status": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Reason": "sample string 1",
"LastUpdatedBy": {
"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
},
"CreatedDate": "2025-07-31T06:58:59.9205735Z",
"LastUpdated": "2025-07-31T06:58:59.9205735Z",
"Id": 4
},
"DocumentType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"DocumentSubType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FileName": "sample string 3",
"ContentType": "sample string 4",
"FileExtension": "sample string 5",
"Description": "sample string 6",
"FileSize": "sample string 7",
"CreatedDate": "2025-07-31T06:58:59.9205735Z",
"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": 9
}
],
"Name": "sample string 1",
"Description": "sample string 2",
"DateTime": "2025-07-31T06:58:59.9205735Z",
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Negotiators": [
{
"ContactName": "sample string 1",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"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 5",
"Id": 6
},
{
"ContactName": "sample string 1",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"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 5",
"Id": 6
}
],
"BranchId": 4,
"OwningTeamId": 5,
"TeamAccessType": "sample string 6",
"CustomFields": [
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
},
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
}
],
"CreatedDate": "2025-07-31T06:58:59.9205735Z",
"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": 8
}