POST api/tenancy/{id}/updatetenancykeyinformation

Updates a tenancies key information Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique identifier of the requested resource.

integer

Required

Body Parameters

The update tenancy key information data contract supplied with the request.

UpdateTenancyKeyInformationDataContract
NameDescriptionTypeAdditional information
AgreementType

The agreement type value.

EnumDataContract

None.

StartDate

The start date, expressed as a date and time.

date

None.

EstimatedStartDate

The estimated start date, expressed as a date and time.

date

None.

NoticePeriod

The notice period value.

EnumDataContract

None.

TenancyType

The tenancy type value.

EnumDataContract

None.

Term

The term value.

EnumDataContract

None.

EndDate

The end date, expressed as a date and time.

date

None.

ServiceLevel

The service level value.

EnumDataContract

None.

TenancyRoleStatus

The tenancy role status value.

EnumDataContract

None.

RentAmount

The rent amount value.

decimal number

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "AgreementType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "StartDate": "2026-07-23T08:23:11.4469013Z",
  "EstimatedStartDate": "2026-07-23T08:23:11.4469013Z",
  "NoticePeriod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenancyType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Term": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "EndDate": "2026-07-23T08:23:11.4469013Z",
  "ServiceLevel": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "TenancyRoleStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RentAmount": 1.0
}

Response Information

Resource Description

The response returned after the operation completes.

integer

Response Formats

application/json, text/json

Sample:
1