Leads

Create Lead

Creates a new lead within Alto

post/leads

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/leads
  • Auth: appAuth (a scheme the document does not define)

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Request body

branchIdinteger required

Unique identifier for the Alto branch receiving the lead.

enquiryType'Unspecified' | 'LookingToBuy' | 'LookingToLet' | 'LookingToRent' | 'LookingToSell' | 'Other'
preferredContactMethod'Unspecified' | 'Email' | 'Phone' | 'Post'
preferredContactTime'Unspecified' | 'Afternoon' | 'Anytime' | 'Evening' | 'Morning'
sourceIdentifierstring required

Unique identifier for this lead.

enquiryDatestring date-time nullable

Enquiry date.

commentstring nullable

Comment from the enquirer.

Example request

{
  "enquirerDetails": {
    "title": "Ms",
    "forename": "Jane",
    "surname": "Smith",
    "phoneNumberDay": "07683726192",
    "phoneNumberEve": "07683726192",
    "email": "jane.smith@enquirer.com",
    "address": {
      "houseName": "Oak Lodge",
      "houseNumber": "14",
      "street": "Oak Street",
      "locality": "St Clement",
      "town": "London",
      "county": "Hampshire",
      "country": "UK",
      "postcode": "SW45 3AP"
    }
  },
  "comment": "I am looking for a rental property that allows pets"
}

Response

A new lead has been created

idstring nullable

The unique identifier of the lead

branchIdstring nullable

The identifier of the branch the lead belongs to

leadStatus'Unspecified' | 'Unprocessed' | 'Processed' | 'Rejected' | 'Accepted'
leadSource'Unspecified' | 'Agent' | 'RightMove' | 'Vebra' | 'Zoopla' | 'Api' | 'ZooplaAdReachExpress' | 'ZooplaAudienceConnect'
enquiryDatestring date-time

The date and time in ISO 8601 format that the lead enquired

createdDatestring date-time

The date and time in ISO 8601 format that the lead was imported into Alto eg. the status of the lead has changed to "Processed"

modifiedDatestring date-time

The date and time in ISO 8601 format that the lead was last modified eg. the status of the lead has changed from "Processed" to "Accepted"

enquiryType'Unspecified' | 'LookingToBuy' | 'LookingToLet' | 'LookingToRent' | 'LookingToSell' | 'Other'
commentstring nullable

Comment or note for the lead

Example response

{
  "id": "76543",
  "branchId": "11",
  "enquiryDate": "2024-11-01T14:07:17.0000000+00:00",
  "createdDate": "2024-11-01T14:07:17.0000000+00:00",
  "modifiedDate": "2024-11-01T14:07:17.0000000+00:00",
  "enquirerDetails": {
    "title": "Ms",
    "forename": "Jane",
    "surname": "Smith",
    "phoneNumberDay": "07683726192",
    "phoneNumberEve": "07683726192",
    "email": "jane.smith@enquirer.com",
    "address": {
      "houseName": "Oak Lodge",
      "houseNumber": "14",
      "street": "Oak Street",
      "locality": "St Clement",
      "town": "London",
      "county": "Hampshire",
      "country": "UK",
      "postcode": "SW45 3AP"
    }
  },
  "contact": {
    "id": "123456"
  },
  "properties": [
    {
      "id": "123456"
    }
  ]
}

Changes

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