Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

How do I use the V4 Applications API to manage leads and tenancy applications?

The V4 Applications API handles lead generation, prospect management, tenancy application submission, property alerts, and sales offers. All endpoints are at https://live-api.letmc.com/v4/applications/.

Lettings lead management workflow

  1. Get branches — GET /v4/applications/{shortName}/company/branches/{offset}/{count}
  2. Create a tenancy application (direct) — POST /v4/applications/{shortName}/prospects/tenancyapplication/{branchID}/ Creates a prospect directly in the system. Sends a confirmation email automatically. Accepts an optional staffID to assign to a specific team member.
  3. Submit a tenancy application (inbox) — POST /v4/applications/{shortName}/prospects/submittenancyapplication Submits the application to the inbox for processing. Also sends a confirmation email and returns an application reference string.
  4. Set up property alerts (optional) — POST /v4/applications/{shortName}/prospects/{branchID}/alerts Creates automated property alerts for the applicant based on their search criteria.

Batch operations: POST /v4/applications/{shortName}/prospects/{branchID} — create multiple prospects simultaneously.

Sales lead management workflow

  1. Create a buyer sales alert — POST /v4/applications/{shortName}/sales/{branchID}/sales/alerts
  2. Submit a sales offer — POST /v4/applications/{shortName}/sales/{salesInstructionID}/offer Sends a confirmation email automatically and returns an offer reference string.

Retrieving matching properties

  • Lettings: GET /v4/applications/{shortName}/prospects/{applicantID}/applicants/{offset}/{count}
  • Sales: GET /v4/applications/{shortName}/sales/{applicantID}/salesinstructions/{offset}/{count}

Managing prospects and buyers

  • Get all lettings prospects by branch: /prospects/{branchID}/{offset}/{count}
  • Get specific prospect: /prospects/prospect/{prospectID}
  • Update prospect: PATCH /prospects/prospect/{prospectID}
  • Get all buyers by branch: /buyer/{branchID}/{offset}/{count}
  • Get specific buyer: /buyers/{prospectID}
  • Get sales offer: /sales/salesoffer/{salesOfferID}

Document management

  • Add document to lettings prospect: POST /documents/prospects/{applicantID}/add
  • Add document to sales buyer: POST /documents/sales/{buyerID}/add

Documents over 10MB are stored as external documents.

Company information and staff

  • Company areas: /company/areas/{offset}/{count}
  • Staff members: /staff/{offset}/{count} — use staff IDs for lead assignment

Email confirmations

The API automatically sends confirmation emails for tenancy application submissions, property alert creation, and sales offer submissions. Ensure valid email addresses are provided.

Data relationships

Branch ID → used in all prospect creation calls | Staff ID → optional for lead assignment | Applicant ID → returned from prospect creation, used for matching and document attachment | Sales Offer ID → returned from offer submission

Test with Swagger: Select "V4.Applications" from the tier dropdown.