Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Leads

Add activity

Add activity to a lead.

post/v1.0/leads/{leadId}/activity

Path parameters

leadIdinteger required

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

typestring required

Specifies the type of activity being logged for the lead.

Accepted Values:

  • Search: When the lead performs a search operation (e.g., filtering by property type like Single Family Home)
  • Browse: When the lead views a property detail page
  • Favorite: When the lead saves a property to favorites
  • Request: When the lead submits a showing request for a property
  • Submission: When the lead submits a form on website
textstring required

Search Text

linkstring required

Url for web page

picturestring required

Preview picture url

createdinteger required

created time in milliseconds

scheduledDatestring

Scheduled date about this showing request

pageNamestring

The page name of the lead's submission(re-inquiry) page

Example request

{
  "type": "Search",
  "text": "Search",
  "link": "https://lofty.com",
  "picture": "https://lofty.com/default.jpg",
  "listing": {
    "price": 100000,
    "state": "California",
    "city": "New York",
    "streetAddress": "22348 Regnart RD",
    "zipCode": "25401",
    "propertyType": "Single Family Home",
    "bedrooms": 3,
    "bathrooms": 2,
    "squareFeet": 100,
    "lotSize": 26.33,
    "parkingSpace": 1,
    "floors": 1,
    "priceMax": 10000000,
    "priceMin": 100000
  },
  "created": 1747272300000,
  "pageName": "Blog Registration"
}

Response

Successful operation.

leadIdinteger

ID of the lead.

Example response

{
  "leadId": 651095960136641
}