POST api/crmconnect/property/instructiontolet

Get the instruction to sell event for a property as a InstructToSellCommandDataContract so that it can be added to the event timeline for rezi when creating a property Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

A value usable to identify the item in the crm, this key is generated by the selected domain service

Object

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{}

Response Information

Resource Description

The response returned after the operation completes.

InstructToLetCommandDataContract

Name	Description	Type	Additional information
RoleId	The unique identifier of the related role resource.	integer	None.
ActualMarketingPrice	The actual marketing price value.	decimal number	None.
OccupierAllowanceDescription	The occupier allowance description value.	OccupierAllowanceDescriptionSaveDataContract	None.
DepositPriceValue	The deposit price value value.	decimal number	None.
DepositScheme	The deposit scheme value.	EnumDataContract	None.
TeamId	The unique identifier of the related team resource.	integer	None.
PutOnMarket	Indicates whether put on market is true.	boolean	None.
TermsReceived	Indicates whether terms received is true.	boolean	None.
InstructedDateTime	The instructed date time, expressed as a date and time.	date	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
LeaseType	The lease type value.	EnumDataContract	None.
AvailableDate	The available date, expressed as a date and time.	date	None.
ValidEpcInPlace	Indicates whether valid epc in place is true.	boolean	None.
ProofOfIdReceived	Indicates whether proof of id received is true.	boolean	None.
ProofOfOwnershipReceived	Indicates whether proof of ownership received is true.	boolean	None.
AgencyPeriod	The agency period value.	EnumDataContract	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
FurnishingLevel	The furnishing level value.	EnumDataContract	None.
SendToPortal	Indicates whether send to portal is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "RoleId": 1,
  "ActualMarketingPrice": 2.1,
  "OccupierAllowanceDescription": {
    "Pairs": [
      {
        "Key": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 1
      },
      {
        "Key": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 1
      }
    ],
    "Name": "sample string 1",
    "Notes": "sample string 2",
    "PropertyId": 3,
    "RoleId": 4,
    "ForceUpdate": true,
    "Id": 6
  },
  "DepositPriceValue": 3.1,
  "DepositScheme": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TeamId": 4,
  "PutOnMarket": true,
  "TermsReceived": true,
  "InstructedDateTime": "2026-07-23T08:23:24.6032515Z",
  "NegotiatorIds": [
    1,
    2
  ],
  "LeaseType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AvailableDate": "2026-07-23T08:23:24.6032515Z",
  "ValidEpcInPlace": true,
  "ProofOfIdReceived": true,
  "ProofOfOwnershipReceived": true,
  "AgencyPeriod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "BranchId": 1,
  "FurnishingLevel": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SendToPortal": true
}