POST api/progression/addprogressionnote
Add a note to a purchasing role Processes this progression API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
Details of the progression note
AddProgressionNoteCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| RoleId |
The unique identifier of the related role resource. |
integer |
None. |
| DateTime |
The date time, expressed as a date and time. |
date |
None. |
| NegotiatorIds |
The unique identifiers of the related negotiator resources. |
Collection of integer |
None. |
| Title |
The title value. |
string |
None. |
| Note |
The note value. |
string |
None. |
| Pinned |
Indicates whether pinned is true. |
boolean |
None. |
| Related |
The related value. |
AddProgressionNoteRelatedCommandDataContract |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"RoleId": 1,
"DateTime": "2026-07-23T08:13:28.7882714Z",
"NegotiatorIds": [
1,
2
],
"Title": "sample string 2",
"Note": "sample string 3",
"Pinned": true,
"Related": {
"RelatedType": 0,
"RelatedId": 1
}
}
Response Information
Resource Description
The response returned after the operation completes.
ProgressionEventDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Roles |
The collection of roles. |
Collection of RoleDataContract |
None. |
| Team |
The team value. |
EventTeamDataContract |
None. |
| Notes |
The collection of notes. |
Collection of EventNoteCommandDataContract |
None. |
| Documents |
The collection of documents. |
Collection of DocumentDataContract |
None. |
| Name |
The name value. |
string |
None. |
| Description |
The description value. |
string |
None. |
| DateTime |
The date time, expressed as a date and time. |
date |
None. |
| EventCategory |
The event category value. |
EnumDataContract |
None. |
| EventType |
The event type value. |
EnumDataContract |
None. |
| EventStatus |
The event status value. |
EnumDataContract |
None. |
| Negotiators |
The collection of negotiators. |
Collection of ListNegotiatorDataContract |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| TeamAccessType |
The team access type value. |
string |
None. |
| CustomFields |
The collection of custom fields. |
Collection of CustomFieldGroupWithValuesDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.