POST api/progression/lettings/createpmtenancy

Create a tenant role 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 add tenant role data contract supplied with the request.

AddTenantRoleDataContract

Name	Description	Type	Additional information
PropertyLettingRoleId	The unique identifier of the related property letting role resource.	integer	None.
OwningTeamGroupId	The unique identifier of the related owning team group resource.	integer	None.
LandlordGroupId	The unique identifier of the related landlord group resource.	integer	None.
TenantGroupId	The unique identifier of the related tenant group resource.	integer	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
StartDate	The start date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
RentAmount	The rent amount value.	decimal number	None.
PriceType	The price type value.	EnumDataContract	None.
Term	The term value.	EnumDataContract	None.
AgreementType	The agreement type value.	EnumDataContract	None.
ServiceLevel	The service level value.	EnumDataContract	None.
TenancyType	The tenancy type value.	EnumDataContract	None.
NoticePeriod	The notice period value.	EnumDataContract	None.
TenancyRoleStatus	The tenancy role status value.	EnumDataContract	None.
DepositScheme	The deposit scheme value.	EnumDataContract	None.
DepositAmount	The deposit amount value.	decimal number	None.
RentSchedule	The rent schedule value.	RecurringScheduleDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PropertyLettingRoleId": 1,
  "OwningTeamGroupId": 2,
  "LandlordGroupId": 3,
  "TenantGroupId": 4,
  "PropertyId": 5,
  "StartDate": "2026-08-05T01:30:05.2554705Z",
  "EndDate": "2026-08-05T01:30:05.2554705Z",
  "RentAmount": 8.0,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AgreementType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ServiceLevel": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenancyType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "NoticePeriod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenancyRoleStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositScheme": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositAmount": 9.1,
  "RentSchedule": {
    "Frequency": 1,
    "StartDate": "2026-08-05T01:30:05.2554705Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  }
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.