POST api/progression/sales/exchange

Exchanges a sales role Processes this sales 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 exchange

ExchangeCommandDataContract
NameDescriptionTypeAdditional information
RoleId

The unique identifier of the related role resource.

integer

None.

ExchangedDateTime

The exchanged date time, expressed as a date and time.

date

None.

EstimatedCompletionDateTime

The estimated completion date time, expressed as a date and time.

date

None.

TakeOffMarket

Indicates whether take off market is true.

boolean

None.

Note

The note value.

string

None.

NegotiatorIds

The unique identifiers of the related negotiator resources.

Collection of integer

None.

FinalAgreedPrice

The final agreed price value.

decimal number

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "RoleId": 1,
  "ExchangedDateTime": "2026-07-23T08:19:07.2738101Z",
  "EstimatedCompletionDateTime": "2026-07-23T08:19:07.2738101Z",
  "TakeOffMarket": true,
  "Note": "sample string 3",
  "NegotiatorIds": [
    1,
    2
  ],
  "FinalAgreedPrice": 1.1
}

Response Information

Resource Description

The response returned after the operation completes.

ExchangedDataContract
NameDescriptionTypeAdditional information
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:

Sample not available.

text/json

Sample:

Sample not available.