Tenancies

Create a tenancy

Asynchronously creates a proposed tenancy. Use the returned TenancyId to poll /tenancies/{tenancyId} to check if the tenancy is created.

post/inventory/{inventoryId}/tenancies

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/inventory/{inventoryId}/tenancies
  • Auth: appAuth (a scheme the document does not define)

Path parameters

inventoryIdinteger required

The property Id

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Request body

rentalAmountnumber double

The rental amount for the proposed tenancy.

applicantContactIdsinteger[] nullable

The ids of all the applicants for the proposed tenancy.

tenancyStartDatestring date-time nullable

The Start Date of the proposed tenancy.

tenancyTermMonthsinteger nullable

The term of the proposed tenancy in months.

tenancyTermYearsinteger nullable

The term of the proposed tenancy in years.

sendDefaultLettersboolean

Whether to send default letters for the proposed tenancy.

Response

Accepted

Changes

No recorded changes to this operation across all 1 revision of this API.