Posting Applications - V4 Applicants API

This documentation is intended for technical teams implementing the API integration. For general questions about application forms and non-technical support, please reach out to our support team at [e-mail].

The Tenancy Applications API allows you to manage tenancy applications, including creating new prospects, submitting applications, and managing lettings property alerts.

Base URL

All API URLs referenced are relative to: https://api.letmc.com/v4/applications

Quick Navigation

Prospect Controller

1. Create Tenancy Application
2. Submit Tenancy Application (In-Tray)
3. Create Lettings Property Alerts
4. Batch Create Applicants
5. Update Applicant
6. Get Matching Lettings Properties

Sales Controller

1. Get Matching Sales Properties
2. Get Sales Offer
3. Submit Sales Offer
4. Create Sales Property Alert

1. Create Tenancy Application

 

Prospect Controller

1. Create Tenancy Application

Create a new prospect directly in the system.

POST /v4/applications/{shortName}/prospects/tenancyapplication/{branchID}/

Parameters
• shortName (path): The unique client shortName
• branchID (path): The branch to link the prospect to
• staffID (query, optional): Link a staff member to the prospect
• Request Body: TenancyApplicationWithAlerts object
Response
Returns a string confirming the creation of the prospect.

2. Submit Tenancy Application (In-Tray)

Submit an online tenancy application to the In Tray.

POST /v4/applications/{shortName}/prospects/submittenancyapplication

Parameters
• shortName (path): The unique client short-name
• branchID (query): The unique ID of the Branch
• staffID (query, optional): Staff member ID
• Request Body: TenancyApplicationWithAlerts object
Response
Returns "Online Tenancy Application Submitted" on success.

3. Create Lettings Property Alerts

Create alerts for lettings properties.

POST /v4/applications/{shortName}/prospects/{branchID}/alerts

Parameters
• shortName (path): The unique client shortName
• branchID (path): The branch to link the prospect to
• staffID (query, optional): Staff member ID
• Request Body: ApplicantSubmissionModel object
Response
Returns a string confirming the creation of the alerts.

4. Batch Create Applicants

Create multiple prospects in the system.

POST /v4/applications/{shortName}/prospects/{branchID}

Parameters
• shortName (path): The unique client shortName
• branchID (path): The unique branchID to link the prospects to
• staffID (query, optional): Staff member ID
• Request Body: Array of TenancyApplicationWithAlerts objects
Response
Returns an array of strings containing creation confirmations.

5. Update Applicant

Update the data for an existing prospect.

PATCH /v4/applications/{shortName}/prospects/prospect/{prospectID}

Parameters
• shortName (path): The unique client shortname
• prospectID (path): The ID of the prospect to modify
• Request Body: ApplicantSubmissionModel object
Response
Returns a string confirming the modification.

6. Get Matching Lettings Properties

Retrieve matching lettings properties for an applicant.

GET /v4/applications/{shortName}/prospects/{applicantID}/applicants/{offset}/{count}

Parameters
• shortName (path): The unique client short-name
• applicantID (path): The unique applicant ID
• offset (path): The index of the first item to return
• count (path): Maximum number of items to return (up to 1000)
Response
Returns a MatchingLettingsResultsModelResults object containing matching properties.
Models
TenancyApplicationWithAlerts

{

  "Documents": [

    {

      "DocumentName": "string",

      "MimeType": "string",

      "Contents": "string"

    }

  ],

  "Applicant": {

    "Title": "string",

    "Forename": "string",

    "Surname": "string",

    "Nationality": "string",

    "MobilePhone": "string",

    "EmailAddress": "string",

    "EmailAlerts": boolean,

    "SMSAlerts": boolean,

    "MinRent": decimal,

    "MaxRent": decimal,

    "NumberOfBeds": integer,

    "RoomInSharedProperty": boolean,

    "TenantType": "string",

    "AreaID": "string",

    "GeneralNotes": "string",

    "PropertyAddress": "string",

    "UniversityNumber": "string",

    "Reference": [

      {

        "Type": "string",

        "OrganisationName": "string",

        "Title": "string",

        "Forename": "string",

        "Surname": "string",

        "Address1": "string",

        "Postcode": "string",

        "Email": "string",

        "MobilePhone": "string"

      }

    ],

    "BankDetails": {

      "BankName": "string",

      "AccountDetails": {

        "AccountNumber": "string",

        "SortCode": "string",

        "AccountName": "string"

      }

    }

ApplicantSubmissionModel

{

  "Title": "string",

  "Forename": "string",

  "Surname": "string",

  "EmailAddress": "string",

  "MobilePhone": "string",

  "EmailAlerts": boolean,

  "SMSAlerts": boolean,

  "MinRent": decimal,

  "MaxRent": decimal,

  "NumberOfBeds": integer,

  "RoomInSharedProperty": boolean,

  "TenantType": "string",

  "AreaID": "string"

}

}

Sales Controller

1. Get Matching Sales Properties

Retrieve sales properties matching an applicant's criteria.

GET /{shortName}/sales/{applicantID}/salesinstructions/{offset}/{count}

Parameters

shortName (path): The unique client short-name
applicantID (path): The unique applicant ID
offset (path): The index of the first item to return
count (path): Maximum number of items to return (up to 1000)

Response
Returns a MatchingSalesResultsModelResults object containing matching properties.

2. Get Sales Offer

GET /{shortName}/sales/salesoffer/{salesOfferID}

Parameters

shortName (path): The unique client short-name
salesOfferID (path): The unique ID of the Sales Offer

Response
Returns a SalesOfferModel object containing the offer details.

3. Submit Sales Offer

Submit an offer for a sales property.

POST /{shortName}/sales/{salesInstructionID}/offer

Parameters

shortName (path): The unique client short-name
branchID (query): The unique branch ID
salesInstructionID (path): The unique ID of the Sales Instruction
applicantsForename (query): Applicant's first name
applicantsSurname (query): Applicant's surname
phoneNumber (query): Applicant's contact number
email (query): Applicant's email
depositType (query): Type of deposit (enum: SalesOfferDeposit)
Request Body: SalesOfferSubmissionModel object

Response
Returns a string confirming the offer submission.

4. Create Sales Property Alert

Create property alerts for a buyer.

POST /{shortName}/sales/{branchID}/sales/alerts

Parameters

shortName (path): The unique client short-name
branchID (path): The branch ID
preferredContact (query): Preferred contact method (enum: SalesContactMethod)
staffID (query, optional): The unique staff ID
Request Body: ApplicantBuyerSubmissionModel object

Response
Returns a string confirming the alert creation.

Models

ApplicantBuyerSubmissionModel

{

  "Title": "string",

  "Forename": "string",

  "Middlename": "string",

  "Surname": "string",

  "Email": "string",

  "Mobile": "string",

  "MaxPrice": decimal,

  "MinimumBedrooms": byte,

  "MinimumReceptionRooms": byte,

  "MinimumBathrooms": byte,

  "MinimumEnsuites": byte,

  "MinimumToilets": byte,

  "SMSAlerts": boolean,

  "EmailAlerts": boolean

}

SalesOfferSubmissionModel

{

  "Amount": decimal,

  "DepositAmount": integer,

  "MortgageAmount": integer,

  "SpecialTerms": "string",

  "FixtureFittings": "string",

  "SubjectToContract": boolean,

  "SubjectToMortgage": boolean,

  "SubjectToSurvey": boolean

}

SalesContactMethod (Enum)

• Telephone
• Email
• SMS
• Letter