---
title: "Create Applicant Requirement"
method: POST
path: "/contacts/{contactId}/applicant-requirements"
tags: ["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

- `contactId` integer, required

## Headers

- `AgencyRef` string, required

## Request body

- AltoContactsApiModelsRequestsPostApplicantRequirementRequest
  - `profileIntention` 'Buy' | 'Rent', required: The Applicant's intention.
  - `isNewBuild` boolean, nullable: Whether the Applicant requires a new build Property.
  - `isActiveProfile` boolean, nullable: Whether the Requirement is active in the Applicant's profile.
  - `priceFrom` integer, nullable: The minimum price of the Property.
  - `priceTo` integer, nullable: The maximum price of the Property.
  - `bedsMin` integer, 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.
  - `notes` string, nullable: Free-text notes for the Requirement.

## Response `201`

Contact created.

- AltoContactsApiModelsResponsesApplicantRequirement
  - `id` string, nullable: The unique identifier for the resource.
  - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities.
    - `href` string, nullable
    - `rel` string, nullable
  - `profileIntention` string, nullable
  - `isNewBuild` boolean, nullable
  - `priceFrom` number, double, nullable
  - `priceTo` number, double, nullable
  - `bedsMin` integer, nullable
  - `isActiveProfile` boolean
  - `rentalIntention` AltoContactsApiModelsResponsesRentalIntention
    - `priceQualifier` 'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays'
    - `furnishing` 'Unspecified' | 'Unfurnished' | 'PartFurnished' | 'Furnished' | 'FurnishedOrUnfurnished', nullable
  - `tenureType` 'Unspecified' | 'Freehold' | 'Leasehold' | 'LeaseholdWithShareOfFreehold' | 'FlyingFreehold' | 'Commonhold' | 'ShareOfFreehold', nullable
  - `notes` string, nullable

## Other responses

- `400`: Invalid request.
- `404`: Applicant not found.

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)