POST api/offer/recordlettingoffer

Record offer on a letting Processes this offer API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The record letting offer command data contract supplied with the request.

RecordLettingOfferCommandDataContract

Name	Description	Type	Additional information
PreferredMoveInDate	The preferred move in date, expressed as a date and time.	date	None.
PreferredEndDate	The preferred end date, expressed as a date and time.	date	None.
PreferredTerm	The preferred term value.	EnumDataContract	None.
DepositAmount	The deposit amount value.	decimal number	None.
DepositScheme	The deposit scheme value.	EnumDataContract	None.
PriceType	The price type value.	EnumDataContract	None.
CreatedFromPM	Indicates whether created from pm is true.	boolean	None.
MarketingRoleId	The unique identifier of the related marketing role resource.	integer	None.
GroupId	The unique identifier of the related group 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.
Value	The value represented by this field.	decimal number	None.
Notes	The notes value.	string	None.
IsNoteOfInterest	Indicates whether this item is note of interest.	boolean	None.
OnBehalfOf	The on behalf of value.	string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PreferredMoveInDate": "2026-07-23T08:17:36.4326986Z",
  "PreferredEndDate": "2026-07-23T08:17:36.4326986Z",
  "PreferredTerm": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositAmount": 2.1,
  "DepositScheme": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "CreatedFromPM": true,
  "MarketingRoleId": 4,
  "GroupId": 5,
  "DateTime": "2026-07-23T08:17:36.4483242Z",
  "NegotiatorIds": [
    1,
    2
  ],
  "Value": 6.1,
  "Notes": "sample string 7",
  "IsNoteOfInterest": true,
  "OnBehalfOf": "sample string 9"
}

Response Information

Resource Description

The response returned after the operation completes.

OfferDataContract

Name	Description	Type	Additional information
VendorCommunication	The vendor communication value.	OfferCommunicationDataContract	None.
Response	The response value.	OfferResponseDataContract	None.
Value	The value represented by this field.	decimal number	None.
ValidFor	The valid for value.	decimal number	None.
Property	The property value.	OfferPropertyDataContract	None.
ApplicantGroup	The applicant group value.	OfferGroupDataContract	None.
VendorGroup	The vendor group value.	OfferGroupDataContract	None.
MarketingRoleId	The unique identifier of the related marketing role resource.	integer	None.
Roles	The collection of roles.	Collection of RoleDataContract	None.
RoleType	The role type value.	EnumDataContract	None.
MarketedPrice	The marketed price value.	PriceDataContract	None.
OnBehalfOf	The on behalf of value.	string	None.
NoteOfInterestId	The unique identifier of the related note of interest resource.	integer	None.
LastUpdated	The last updated, expressed as a date and time.	date	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:

Sample not available.

text/json

Sample:

Sample not available.