POST api/progression/lettings/let
Set letting to Let (Occupied) Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The let command data contract supplied with the request.
LetCommandDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| RoleId |
The unique identifier of the related role resource. |
integer |
None. |
| LetDateTime |
The let date time, expressed as a date and time. |
date |
None. |
| LetEndDateTime |
The let end 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. |
| IssueNoticeDate |
The issue notice date, expressed as a date and time. |
date |
None. |
| CompleteTenantRoles |
Indicates whether complete tenant roles is true. |
boolean |
None. |
| NextInspectionDate |
The next inspection date, expressed as a date and time. |
date |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"RoleId": 1,
"LetDateTime": "2026-07-23T08:21:56.3854635Z",
"LetEndDateTime": "2026-07-23T08:21:56.3854635Z",
"TakeOffMarket": true,
"Note": "sample string 3",
"NegotiatorIds": [
1,
2
],
"IssueNoticeDate": "2026-07-23T08:21:56.3854635Z",
"CompleteTenantRoles": true,
"NextInspectionDate": "2026-07-23T08:21:56.3854635Z"
}
Response Information
Resource Description
The response returned after the operation completes.
LetDataContract| Name | Description | Type | Additional 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 not available.
text/json
Sample not available.