POST api/tenancy/{id}/renew

Renew Tenancy. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required

Body Parameters

The renew tenancy data contract supplied with the request.

RenewTenancyDataContract

Name	Description	Type	Additional information
RentAmount	The rent amount value.	decimal number	None.
DepositAmount	The deposit amount value.	decimal number	None.
DepositProtectionStatus	The deposit protection status value.	EnumDataContract	None.
DepositScheme	The deposit scheme value.	EnumDataContract	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.
RentSchedule	The rent schedule value.	RecurringScheduleDataContract	None.
Term	The term value.	EnumDataContract	None.
FurnishLevel	The furnish level value.	EnumDataContract	None.
AdditionalClauses	The collection of additional clauses.	Collection of AddTenantClauseDataContract	None.
PriceType	The price type value.	EnumDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "RentAmount": 1.0,
  "DepositAmount": 1.0,
  "DepositProtectionStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DepositScheme": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "StartDate": "2026-07-23T08:18:22.1792528Z",
  "EndDate": "2026-07-23T08:18:22.1792528Z",
  "RentSchedule": {
    "Frequency": 1,
    "StartDate": "2026-07-23T08:18:22.1792528Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FurnishLevel": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AdditionalClauses": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ClauseType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ForceUpdate": true,
      "Id": 4
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ClauseType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ForceUpdate": true,
      "Id": 4
    }
  ],
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.