Contacts

Update Applicant Requirement by Id

patch/contacts/{contactId}/applicant-requirements/{requirementId}

Request

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

Path parameters

contactIdstring required

The unique identifier for the Contact.

requirementIdstring required

The unique identifier for the Applicant Requirement.

Headers

AgencyRefstring required

Request body

Example request

[
  {
    "value": "Buy",
    "path": "/ProfileIntention"
  }
]

Response

Returns the updated Applicant Requirement.

idstring nullable

The unique identifier for the resource.

profileIntention'Unspecified' | 'Buy' | 'Rent'

The Applicant's intention.

isNewBuildboolean nullable

Whether the Applicant requires a new build Property.

isActiveProfileboolean

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.

tenureType'Unspecified' | 'Freehold' | 'Leasehold' | 'LeaseholdWithShareOfFreehold' | 'FlyingFreehold' | 'Commonhold' | 'ShareOfFreehold' nullable

The tenure the Applicant is looking for.

notesstring nullable

Free-text notes for the Requirement.

Example response

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

Changes

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