Contacts

Create Applicant Requirement

post/contacts/{contactId}/applicant-requirements

Request

Base URL: https://api.alto.zoopladev.co.uk
URL: https://api.alto.zoopladev.co.uk/contacts/{contactId}/applicant-requirements
Auth: appAuth (a scheme the document does not define)

Path parameters

contactIdinteger required

The unique identifier for the Contact.

Headers

AgencyRefstring required

Request body

profileIntention'Buy' | 'Rent' required

The Applicant's intention.

isNewBuildboolean nullable

Whether the Applicant requires a new build Property.

isActiveProfileboolean nullable

Whether the Requirement is active in the Applicant's profile.

priceFrominteger nullable

The minimum price of the Property.

priceTointeger nullable

The maximum price of the Property.

bedsMininteger nullable

The minimum number of bedrooms of the Property.

rentalPriceQualifier'Weekly' | 'Monthly' nullable

The frequency of the rental payment.

rentalFurnishing'Furnished' | 'PartFurnished' | 'Unfurnished' | 'Unspecified' nullable

The furnishing requirement of the desired property.

tenureType'Freehold' | 'Leasehold' | 'Unspecified' nullable

The tenure the Applicant is looking for.

notesstring nullable

Free-text notes for the Requirement.

Example request

{
  "profileIntention": "Buy",
  "isNewBuild": true,
  "isActiveProfile": true,
  "priceFrom": 50000,
  "priceTo": 100000,
  "bedsMin": 2,
  "rentalPriceQualifier": "Monthly",
  "rentalFurnishing": "Furnished",
  "tenureType": "Freehold",
  "notes": "Looking for a garden and off-street parking."
}

Response

Contact created.

idstring nullable

The unique identifier for the resource.

profileIntentionstring nullable

isNewBuildboolean nullable

priceFromnumber double nullable

priceTonumber double nullable

bedsMininteger nullable

isActiveProfileboolean

notesstring nullable

Changes

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