Domain > api-docs.ylopo.com

More information on this domain is in AlienVault OTX

DNS Resolutions

Date	IP Address
2024-10-15	52.92.230.27 (ClassC)
2025-11-17	52.92.162.211 (ClassC)

HTTP/1.1 200 OKx-amz-id-2: p4JEwYSIhcPi4k1xgTBbuxXkqO/MQ1uG6Dkud/r7C7boN+oBy3AbWMU3A9bWtuVIuPlWM5O2KVIx-amz-request-id: 72JFT73YB90Z3M9CDate: Mon, 17 Nov 2025 12:29:07 GMTLast-Modified: Fri, 14 May 2021 20:06:10 GMTETag: 83f1ae3971bb13c9b1519c1c40777f71Content-Type: text/htmlContent-Length: 99225Server: AmazonS3

!doctype html>html classno-js langen> head> meta charsetutf-8 /> meta nameviewport contentwidthdevice-width, initial-scale1.0 /> title>Ylopo API | API Reference/title> link relstylesheet hrefstylesheets/foundation.min.css /> link relstylesheet hrefstylesheets/spectacle.min.css /> script srchttps://code.jquery.com/jquery-2.1.4.min.js>/script> !-- script srcjavascripts/foundation.js>/script> --> script srcjavascripts/spectacle.min.js>/script> /head> body idspectacle> div idpage classdrawer-layout drawer-slide-right-large> div idsidebar> button classclose-button aria-labelClose menu typebutton data-drawer-close> span aria-hiddentrue>×/span> /button> div idlogo> img srcimages/ylopo.png titleYlopo API /> /div> nav idnav rolenavigation> h5>Topics/h5> a href#introduction>Introduction/a> a href#authentication>Authentication/a> h5>Paths/h5> !-- section> a href#path--lead>/lead/a> ul> --> !-- li> --> a href#operation--lead-post> Add Lead /a> !-- /li> --> !-- li> --> a href#operation--lead-put> Update Lead /a> !-- /li> --> !-- /ul> /section> --> h5>Schema Definitions/h5> a href#definition-AddLead> AddLead /a> a href#definition-UpdateLead> UpdateLead /a> a href#definition-Lead> Lead /a> a href#definition-SearchAlert> SearchAlert /a> a href#definition-LeadAcceptedResponse> LeadAcceptedResponse /a> a href#definition-BadRequestResponse> BadRequestResponse /a> a href#definition-NotFoundResponse> NotFoundResponse /a> /nav> /div> div iddocs classrow collapse expanded drawer data-drawer> button classfloating-menu-icon typebutton data-drawer-slideright> span classhamburger>/span> /button> div classexample-box doc-content>/div> article> h1 classdoc-title>Ylopo API span>API Reference/span> /h1> div idintroduction data-traverse-targetintroduction> div classdoc-row> div classdoc-copy> h1 idsetup>Setup/h1> p>When a Ylopo client wants to integrate with a new CRM, a client-specific apiKey is generated as part of the setup process and shared with the target CRM. The target CRM will use this apiKey to validate payloads received as well as authenticate payloads sent. The target CRM will also provide a delivery URL which Ylopo will use deliver all payloads to./p> h1 idnew-lead-delivery-from-ylopo>New Lead Delivery From Ylopo/h1> p>When a new lead is created in Ylopo, a REGISTRATION event is sent containing the lead data, assignment information, recent engagement statistics, and links to management pages. Example payload:/p> pre>code classhljs>{ span classhljs-attr>source/span>: span classhljs-string>Ylopo/span>, span classhljs-attr>sourceDetail/span>: span classhljs-string>YLOPO_ADWORDS/span>, span classhljs-attr>eventType/span>: span classhljs-string>REGISTRATION/span>, span classhljs-attr>message/span>: span classhljs-string>Registration: \nYlopo ID: 196282 \nLead Type: SELLER \nStars: https://stars.ylopo.com/lead-detail/abc123/span>, span classhljs-attr>lead/span>: { span classhljs-attr>firstName/span>: span classhljs-string>John/span>, span classhljs-attr>lastName/span>: span classhljs-string>Smith/span>, span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>createdAt/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>referrerDomain/span>: span classhljs-string>http://some.referrerdomain.com/span>, span classhljs-attr>starsLink/span>: span classhljs-string>https://stars.ylopo.com/lead-detail/abc123/span>, span classhljs-attr>tags/span>: span classhljs-string>MANUAL/span>, span classhljs-string>FOO/span> , span classhljs-attr>leadType/span>: span classhljs-string>SELLER/span>, span classhljs-attr>assignments/span>: { span classhljs-attr>type/span>: span classhljs-string>realtor/span>, span classhljs-attr>name/span>: span classhljs-string>Bob Realtor/span>, span classhljs-attr>crmId/span>: span classhljs-string>1234/span>, span classhljs-attr>email/span>: span classhljs-string>bobrealtor@ylopo.com/span> }, { span classhljs-attr>type/span>: span classhljs-string>lender/span>, span classhljs-attr>name/span>: span classhljs-string>Jake Lender/span>, span classhljs-attr>crmId/span>: span classhljs-string>1235/span>, span classhljs-attr>email/span>: span classhljs-string>jakelender@ylopo.com/span> } , span classhljs-attr>assignedWebsite/span>: span classhljs-string>http://portal.ylopo.com/span>, span classhljs-attr>lastSessionAvgPrice/span>: span classhljs-number>761750/span>, span classhljs-attr>lastSessionListingsViewed/span>: span classhljs-number>4/span>, span classhljs-attr>lastSessionSearches/span>: span classhljs-number>2/span>, span classhljs-attr>lastSessionListingsSaved/span>: span classhljs-number>0/span>, span classhljs-attr>lastSessionShowingInfoRequests/span>: span classhljs-number>2/span>, span classhljs-attr>lastSessionTotalVisits/span>: span classhljs-number>1/span>, span classhljs-attr>lastSessionLastVisitDate/span>: span classhljs-string>2018-08-21T19:41:22.743Z/span>, span classhljs-attr>editPushNotificationsLink/span>: span classhljs-string>https://stars.ylopo.com/abcde/span>, span classhljs-attr>editListingAlertLink/span>: span classhljs-string>https://stars.ylopo.com/fghij/span>, span classhljs-attr>viewBrowsingHistoryLink/span>: span classhljs-string>https://stars.ylopo.com/klmno/span> }, span classhljs-attr>listing/span>: { span classhljs-attr>mlsNumber/span>: span classhljs-string>ABC123/span>, span classhljs-attr>url/span>: span classhljs-string>http://portal.ylopo.com/listing-detail/12345/span>, span classhljs-attr>address/span>: span classhljs-string>123 Easy St./span>, span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>zip/span>: span classhljs-string>91316/span>, span classhljs-attr>bedrooms/span>: span classhljs-number>4/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>type/span>: span classhljs-string>Single Family Residence/span>, span classhljs-attr>sqFt/span>: span classhljs-number>1303/span>, span classhljs-attr>price/span>: span classhljs-number>799000/span>, span classhljs-attr>yearBuilt/span>: span classhljs-number>1949/span>, span classhljs-attr>images/span>: // listing image urls },}/code>/pre> h1 idcontinuous-lead-updates-webhooks->Continuous Lead Updates (Webhooks)/h1> p>Following a REGISTRATION, ongoing updates are continually sent as the lead engages and advances through their home search experience and interacts with our systems. These webhooks are detailed below./p> h3 idinitial-landing>Initial Landing/h3> p>The lead began a new session on the home search site./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>INITIAL_LANDING/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Lead logged into home search site/span>, span classhljs-attr>url/span>: span classhljs-string>https://portal.ylopo.com/span>}/code>/pre> h3 idshowing-request>Showing Request/h3> p>The lead requested a showing for a given listing on the home search site. This is triggerred by an explicit button click and form submission./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>SHOWING_REQUEST/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>listing/span>: { span classhljs-attr>mlsNumber/span>: span classhljs-string>ABC123/span>, span classhljs-attr>url/span>: span classhljs-string>http://portal.ylopo.com/listing-detail/12345/span>, span classhljs-attr>address/span>: span classhljs-string>123 Easy St./span>, span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>zip/span>: span classhljs-string>91316/span>, span classhljs-attr>bedrooms/span>: span classhljs-number>4/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>type/span>: span classhljs-string>Single Family Residence/span>, span classhljs-attr>sqFt/span>: span classhljs-number>1303/span>, span classhljs-attr>price/span>: span classhljs-number>799000/span>, span classhljs-attr>yearBuilt/span>: span classhljs-number>1949/span>, span classhljs-attr>images/span>: // listing image urls }, span classhljs-attr>message/span>: span classhljs-string>Lead requested info or a showing of a property: \nhttp://portal.ylopo.com/listing-detail/12345 \n123 Easy St. \nEncino, CA 91316 \nPrice: $799,000 \n \nMessage: I am interested in scheduling a showing for 123 Easy St Encino CA 91316. Please call me to coordinate. \nFull Name: John Smith \nPhone Number: 5555555555 \nEmail Address: johnsmith@ylopo.com/span>}/code>/pre> h3 idrequest-information>Request Information/h3> p>The lead requested information on the home search site. This is triggered by an explicit button click and form submission. This can also include a listing object, if appropriate and known./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>REQUEST_INFORMATION/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>listing/span>: { span classhljs-attr>mlsNumber/span>: span classhljs-string>ABC123/span>, span classhljs-attr>url/span>: span classhljs-string>http://portal.ylopo.com/listing-detail/12345/span>, span classhljs-attr>address/span>: span classhljs-string>123 Easy St./span>, span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>zip/span>: span classhljs-string>91316/span>, span classhljs-attr>bedrooms/span>: span classhljs-number>4/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>type/span>: span classhljs-string>Single Family Residence/span>, span classhljs-attr>sqFt/span>: span classhljs-number>1303/span>, span classhljs-attr>price/span>: span classhljs-number>799000/span>, span classhljs-attr>yearBuilt/span>: span classhljs-number>1949/span>, span classhljs-attr>images/span>: // listing image urls }, span classhljs-attr>message/span>: span classhljs-string>Lead requested info for seller offer PRIVATE_SHOWING: \nMessage: Hi, Im interested in talking to you about setting up a private showing for your buyers who are looking for a property similar to mine! \nFull Name: John Smith \nHome Address: 123 Easy St \nPhone Number: 5555555555 \nEmail Address: johnsmith@ylopo.com/span>}/code>/pre> h3 idfavorite-listing>Favorite Listing/h3> p>The lead favorited a given listing. This is triggered by an explicit button click./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>FAVORITE_LISTING/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Lead favorited a listing \nhttp://portal.ylopo.com/listing-detail/12345 \n123 Easy St. \nEncino, CA 91316 \nPrice: $799,000 \n \n/span>, span classhljs-attr>listing/span>: { span classhljs-attr>mlsNumber/span>: span classhljs-string>ABC123/span>, span classhljs-attr>url/span>: span classhljs-string>http://portal.ylopo.com/listing-detail/12345/span>, span classhljs-attr>address/span>: span classhljs-string>123 Easy St./span>, span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>zip/span>: span classhljs-string>91316/span>, span classhljs-attr>bedrooms/span>: span classhljs-number>4/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>type/span>: span classhljs-string>Single Family Residence/span>, span classhljs-attr>sqFt/span>: span classhljs-number>1303/span>, span classhljs-attr>price/span>: span classhljs-number>799000/span>, span classhljs-attr>yearBuilt/span>: span classhljs-number>1949/span>, span classhljs-attr>images/span>: // listing image urls },}/code>/pre> h3 idview-listing-detail>View Listing Detail/h3> p>The lead viewed a given listing. This is triggered by visiting a listing detail page from either an email alert click or by clicking the listing from the results on the search site./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>VIEW_LISTING_DETAIL/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Lead viewed a listing \nhttp://portal.ylopo.com/listing-detail/12345 \n123 Easy St. \nEncino, CA 91316 \nPrice: $799,000 \n \n/span>, span classhljs-attr>listing/span>: { span classhljs-attr>mlsNumber/span>: span classhljs-string>ABC123/span>, span classhljs-attr>url/span>: span classhljs-string>http://portal.ylopo.com/listing-detail/12345/span>, span classhljs-attr>address/span>: span classhljs-string>123 Easy St./span>, span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>zip/span>: span classhljs-string>91316/span>, span classhljs-attr>bedrooms/span>: span classhljs-number>4/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>type/span>: span classhljs-string>Single Family Residence/span>, span classhljs-attr>sqFt/span>: span classhljs-number>1303/span>, span classhljs-attr>price/span>: span classhljs-number>799000/span>, span classhljs-attr>yearBuilt/span>: span classhljs-number>1949/span>, span classhljs-attr>images/span>: // listing image urls },}/code>/pre> h3 idsearch>Search/h3> p>The lead searched for listings on the search site with the given search parameters./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>SEARCH/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Lead searched for homes/span>, span classhljs-attr>search/span>: { span classhljs-attr>minPrice/span>: span classhljs-number>402500/span>, span classhljs-attr>sqFtMin/span>: span classhljs-number>2000/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>locations/span>: { span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>postalCode/span>: span classhljs-string>91416/span> }, }}/code>/pre> h3 idsaved-search>Saved Search/h3> p>The lead saved a search for future use. This search is often also used in automatic listing alert emails based on these search parameters./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>SAVED_SEARCH/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Lead saved a search in Encino, CA (+3 locations)/span>, span classhljs-attr>search/span>: { span classhljs-attr>bedrooms/span>: span classhljs-number>3/span>, span classhljs-attr>bathrooms/span>: span classhljs-number>2/span>, span classhljs-attr>sqFtMin/span>: span classhljs-number>2000/span>, span classhljs-attr>sqFtMax/span>: span classhljs-number>3000/span>, span classhljs-attr>priceMin/span>: span classhljs-number>800000/span>, span classhljs-attr>priceMax/span>: span classhljs-number>2000000/span>, span classhljs-attr>locations/span>: { span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span> }, { span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>neighborhood/span>: span classhljs-string>Encino Hills/span> }, { span classhljs-attr>city/span>: span classhljs-string>Encino/span>, span classhljs-attr>state/span>: span classhljs-string>CA/span>, span classhljs-attr>subdivision/span>: span classhljs-string>Encino Park/span> }, { span classhljs-attr>zip/span>: span classhljs-string>91316/span> } }}/code>/pre> h3 idquestionnaire-submission>Questionnaire Submission/h3> p>The lead submitted a response to a questionnaire popup form during their home search process./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>QUESTIONNAIRE_SUBMISSION/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Lead submitted a response to a questionnaire form: \nTime Frame: Im casually browsing right now \n/span>}/code>/pre> h3 idstats-update>Stats Update/h3> p>Not necessarilly triggered by any specific lead activity, but provides the latest session's engagement stats along with the latest links to the various management pages./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>STATS_UPDATE/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span>, span classhljs-attr>leadType/span>: span classhljs-string>BUYER/span>, span classhljs-attr>starsLink/span>: span classhljs-string>https://stars.ylopo.com/lead-detail/abc123/span>, span classhljs-attr>lastSessionAvgPrice/span>: span classhljs-number>761750/span>, span classhljs-attr>lastSessionListingsViewed/span>: span classhljs-number>4/span>, span classhljs-attr>lastSessionSearches/span>: span classhljs-number>2/span>, span classhljs-attr>lastSessionListingsSaved/span>: span classhljs-number>0/span>, span classhljs-attr>lastSessionShowingInfoRequests/span>: span classhljs-number>2/span>, span classhljs-attr>lastSessionTotalVisits/span>: span classhljs-number>1/span>, span classhljs-attr>lastSessionLastVisitDate/span>: span classhljs-string>2018-08-21T19:41:22.743Z/span>, span classhljs-attr>editPushNotificationsLink/span>: span classhljs-string>https://stars.ylopo.com/abcde/span>, span classhljs-attr>editListingAlertLink/span>: span classhljs-string>https://stars.ylopo.com/fghij/span>, span classhljs-attr>viewBrowsingHistoryLink/span>: span classhljs-string>https://stars.ylopo.com/klmno/span> }}/code>/pre> h3 idnote>Note/h3> p>Something occurred which was deemed worth passing along as a note about the lead. Its contents could contain anything, but the noteType field is a good categorical indicator./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>NOTE/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>noteType/span>: span classhljs-string>TEXT_AUTOMATION/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Drip Text Sent to Lead: This is a test. <a href\https://stars.ylopo.com/lead-detail/abc123\>Stars Link</a>/span>, span classhljs-attr>messagePlainText/span>: span classhljs-string>Drip Text Sent to Lead: This is a test. Stars Link: https://stars.ylopo.com/lead-detail/abc123/span>}/code>/pre> h3 idpriority-lead-event>Priority Lead Event/h3> p>Ylopo determined sufficient lead engagment to indicate that this lead should be considered a priority. This can be triggered by a variety of factors which are sometimes altered./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>PRIORITY_LEAD_EVENT/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>message/span>: span classhljs-string>Ylopo Urgent Priority Lead: This lead returned after 60 days and viewed 8 listings/span>, span classhljs-attr>messagePlainText/span>: span classhljs-string>Ylopo Urgent Priority Lead: This lead returned after 60 days and viewed 8 listings/span>}/code>/pre> h3 idtag-added-removed>Tag Added/Removed/h3> p>Ylopo automatically added and/or removed tag(s) from the lead based on some lead engagement or activity./p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>TAG/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span>, span classhljs-attr>uuid/span>: span classhljs-string>3e0adfb9-ce2d-44d9-ad43-515dea9d22e9/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>addedTags/span>: span classhljs-string>AI_NEEDS_FOLLOW_UP/span> , span classhljs-attr>removedTags/span>: span classhljs-string>AI_RESPONDED/span>, span classhljs-string>AI_ENGAGED/span>, span classhljs-string>AI_NOT_INTERESTED/span>, span classhljs-string>AI_SUGGEST_FALLBACK/span> }/code>/pre> h3 idcontact-information-updated>Contact Information Updated/h3> p>The agent or lead updated the lead's contact information on file/p> pre>code classhljs>{ span classhljs-attr>eventType/span>: span classhljs-string>CONTACT_INFO_UPDATED/span>, span classhljs-attr>eventDate/span>: span classhljs-string>2017-05-22T21:23:49.729Z/span>, span classhljs-attr>lead/span>: { span classhljs-attr>email/span>: span classhljs-string>johndoe@ylopo.com/span>, span classhljs-attr>firstName/span>: span classhljs-string>John/span>, span classhljs-attr>lastName/span>: span classhljs-string>Doe/span>, span classhljs-attr>phone/span>: span classhljs-string>123-456-7890/span>, span classhljs-attr>uuid/span>: span classhljs-string>abcd-1234/span>, span classhljs-attr>crmId/span>: span classhljs-string>1/span> }, span classhljs-attr>previousInfo/span>: { span classhljs-attr>email/span>: span classhljs-string>johnsmith@ylopo.com/span>, span classhljs-attr>firstName/span>: span classhljs-string>John/span>, span classhljs-attr>lastName/span>: span classhljs-string>Smith/span>, span classhljs-attr>phone/span>: span classhljs-string>5555555555/span> }}/code>/pre> h1 iddata-delivery-to-ylopo>Data Delivery To Ylopo/h1> p>New leads and updates to existing leads can also be sent to Ylopo using the designated client-specific apiKey. For details, see the route and model definitions below./p> /div> div classdoc-examples> section> h5>API Endpoint/h5> !-- div classhljs> -->pre>code>https://api.ylopo.com/interchange-staging/code>/pre> !-- /div> --> h5>Contact: a hrefmailto:support@ylopo.com>support@ylopo.com/a> /h5> h5>Schemes: span>https/span> /h5> h5>Version: span>v1/span> /h5> /section> /div> /div> /div> !-- h1 idsecurity data-traverse-targetsecurity>Security/h1> --> h1 idauthentication data-traverse-targetauthentication>Authentication/h1> div idsecurity-definition-ApiKeyAuth classpanel> div classdoc-row> div classdoc-copy> h3 classsecurity-definition-title> span classsecurity-name>ApiKeyAuth/span> span classswagger-security-definition-apiKey>/span> /h3> section classswagger-security-definition-properties> div classprop-row security-definition-property> div classprop-name> div classprop-title security-definition-property-name>type/div> /div> div classprop-value security-definition-property-type> apiKey /div> /div> div classprop-row security-definition-property> div classprop-name> div classprop-title security-definition-property-name>in/div> /div> div classprop-value security-definition-property-type> header /div> /div> div classprop-row security-definition-property> div classprop-name> div classprop-title security-definition-property-name>name/div> /div> div classprop-value security-definition-property-type> X-Api-Key /div> /div> /section> /div> /div> /div> h1>Paths/h1> span idpath--lead>/span> div idoperation--lead-post classoperation panel data-traverse-targetoperation--lead-post> h2 classoperation-title> span classoperation-summary>Add Lead/span> /h2> div classdoc-row> div classdoc-copy> section classswagger-operation-path> span classoperation-method>POST/span> span classoperation-path>/lead/span> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-operation-description> p>Send a new lead to Ylopo. If a duplicate is found, we will attempt to update it instead. Note that this means any fields provided which are not valid in a PUT /lead are ignored in the case of dupes./p> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-request-body> div classprop-row> div classprop-name> div classswagger-request-model> span class> a classjson-schema-ref href#/definitions/AddLead>AddLead/a> /span> /div> /div> div classprop-value columns small-6> !-- div classswagger-request-description> --> p>New lead and related data to deliver to Ylopo/p> !-- /div> --> /div> /div> /section> /div> div classdoc-examples> section> h5>Request Content-Types: span>application/json/span> /h5> h5>Request Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"partnerName"/span>: span classhljs-string>"Leads, INC"/span>, span classhljs-attr>"lead"/span>: { span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"johnsmith@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"5555555555"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1"/span>, span classhljs-attr>"crmUrl"/span>: span classhljs-string>"https://some-crm-url.com/1"/span>, span classhljs-attr>"crmCreatedAt"/span>: span classhljs-string>"2017-04-14T18:31:19.000Z"/span>, span classhljs-attr>"deleted"/span>: span classhljs-literal>false/span>, span classhljs-attr>"source"/span>: span classhljs-string>"Google"/span>, span classhljs-attr>"leadType"/span>: span classhljs-string>"BUYER"/span>, span classhljs-attr>"status"/span>: span classhljs-string>"New"/span>, span classhljs-attr>"firstName"/span>: span classhljs-string>"John"/span>, span classhljs-attr>"middleName"/span>: span classhljs-string>"Jacob"/span>, span classhljs-attr>"lastName"/span>: span classhljs-string>"Smith"/span>, span classhljs-attr>"tags"/span>: span classhljs-string>"HOT"/span> , span classhljs-attr>"assignments"/span>: { span classhljs-attr>"type"/span>: span classhljs-string>"realtor"/span>, span classhljs-attr>"name"/span>: span classhljs-string>"Bob Realtor"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1234"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"bobrealtor@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"555-555-5555"/span> } , span classhljs-attr>"additionalData"/span>: { span classhljs-attr>"someString"/span>: span classhljs-string>"TEST"/span>, span classhljs-attr>"someCount"/span>: span classhljs-number>5/span>, span classhljs-attr>"someArray"/span>: span classhljs-string>"TEST1"/span>, span classhljs-string>"TEST2"/span> } }, span classhljs-attr>"searchAlert"/span>: { span classhljs-attr>"locations"/span>: { span classhljs-attr>"city"/span>: span classhljs-string>"Venice"/span>, span classhljs-attr>"state"/span>: span classhljs-string>"CA"/span> }, { span classhljs-attr>"county"/span>: span classhljs-string>"Los Angeles"/span>, span classhljs-attr>"state"/span>: span classhljs-string>"CA"/span> }, { span classhljs-attr>"postalCode"/span>: span classhljs-string>"90210"/span> } , span classhljs-attr>"minPrice"/span>: span classhljs-number>50000/span>, span classhljs-attr>"maxPrice"/span>: span classhljs-number>500000/span>, span classhljs-attr>"bathrooms"/span>: span classhljs-number>2/span>, span classhljs-attr>"bedrooms"/span>: span classhljs-number>4/span> }}/code>/pre> !-- /div> --> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-responses> div classprop-row prop-group> div classprop-name> div classprop-title>200 OK/div> div classprop-ref> span class> a classjson-schema-ref href#/definitions/LeadAcceptedResponse>LeadAcceptedResponse/a> /span> /div> !-- span classswagger-global>/span> span classjson-schema-reference>a href>/a>/span> --> /div> div classprop-value> p>Lead accepted/p> /div> /div> div classprop-row prop-group> div classprop-name> div classprop-title>400 Bad Request/div> div classprop-ref> span class> a classjson-schema-ref href#/definitions/BadRequestResponse>BadRequestResponse/a> /span> /div> !-- span classswagger-global>/span> span classjson-schema-reference>a href>/a>/span> --> /div> div classprop-value> p>Bad request (auth, formatting, or validation error)/p> /div> /div> /section> /div> div classdoc-examples> h5>Response Content-Types: span>application/json/span> /h5> section> h5>Response Example span>(200 OK)/span> /h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>true/span>, span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>}/code>/pre> !-- /div> --> /section> section> h5>Response Example span>(400 Bad Request)/span> /h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>false/span>, span classhljs-attr>"error"/span>: span classhljs-literal>true/span>, span classhljs-attr>"message"/span>: span classhljs-string>"X-Api-Key header is required"/span>}/code>/pre> !-- /div> --> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-request-security> table classtable> thead> tr> th classswagger-request-security-schema>/th> th classswagger-request-security-scopes>/th> /tr> /thead> tbody> tr> td> a href#security-definition-ApiKeyAuth>ApiKeyAuth/a> /td> td> /td> /tr> /tbody> /table> /section> /div> /div> /div> div idoperation--lead-put classoperation panel data-traverse-targetoperation--lead-put> h2 classoperation-title> span classoperation-summary>Update Lead/span> /h2> div classdoc-row> div classdoc-copy> section classswagger-operation-path> span classoperation-method>PUT/span> span classoperation-path>/lead/span> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-operation-description> p>Update an existing lead in Ylopo/p> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-request-body> div classprop-row> div classprop-name> div classswagger-request-model> span class> a classjson-schema-ref href#/definitions/UpdateLead>UpdateLead/a> /span> /div> /div> div classprop-value columns small-6> !-- div classswagger-request-description> --> p>Existing lead with new data to update in Ylopo/p> !-- /div> --> /div> /div> /section> /div> div classdoc-examples> section> h5>Request Content-Types: span>application/json/span> /h5> h5>Request Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"lead"/span>: { span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"johnsmith@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"5555555555"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1"/span>, span classhljs-attr>"crmUrl"/span>: span classhljs-string>"https://some-crm-url.com/1"/span>, span classhljs-attr>"crmCreatedAt"/span>: span classhljs-string>"2017-04-14T18:31:19.000Z"/span>, span classhljs-attr>"deleted"/span>: span classhljs-literal>false/span>, span classhljs-attr>"source"/span>: span classhljs-string>"Google"/span>, span classhljs-attr>"leadType"/span>: span classhljs-string>"BUYER"/span>, span classhljs-attr>"status"/span>: span classhljs-string>"New"/span>, span classhljs-attr>"firstName"/span>: span classhljs-string>"John"/span>, span classhljs-attr>"middleName"/span>: span classhljs-string>"Jacob"/span>, span classhljs-attr>"lastName"/span>: span classhljs-string>"Smith"/span>, span classhljs-attr>"tags"/span>: span classhljs-string>"HOT"/span> , span classhljs-attr>"assignments"/span>: { span classhljs-attr>"type"/span>: span classhljs-string>"realtor"/span>, span classhljs-attr>"name"/span>: span classhljs-string>"Bob Realtor"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1234"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"bobrealtor@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"555-555-5555"/span> } , span classhljs-attr>"additionalData"/span>: { span classhljs-attr>"someString"/span>: span classhljs-string>"TEST"/span>, span classhljs-attr>"someCount"/span>: span classhljs-number>5/span>, span classhljs-attr>"someArray"/span>: span classhljs-string>"TEST1"/span>, span classhljs-string>"TEST2"/span> } }}/code>/pre> !-- /div> --> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-responses> div classprop-row prop-group> div classprop-name> div classprop-title>200 OK/div> div classprop-ref> span class> a classjson-schema-ref href#/definitions/LeadAcceptedResponse>LeadAcceptedResponse/a> /span> /div> !-- span classswagger-global>/span> span classjson-schema-reference>a href>/a>/span> --> /div> div classprop-value> p>Lead accepted/p> /div> /div> div classprop-row prop-group> div classprop-name> div classprop-title>400 Bad Request/div> div classprop-ref> span class> a classjson-schema-ref href#/definitions/BadRequestResponse>BadRequestResponse/a> /span> /div> !-- span classswagger-global>/span> span classjson-schema-reference>a href>/a>/span> --> /div> div classprop-value> p>Bad request (auth, formatting, or validation error)/p> /div> /div> div classprop-row prop-group> div classprop-name> div classprop-title>404 Not Found/div> div classprop-ref> span class> a classjson-schema-ref href#/definitions/NotFoundResponse>NotFoundResponse/a> /span> /div> !-- span classswagger-global>/span> span classjson-schema-reference>a href>/a>/span> --> /div> div classprop-value> p>Lead not found/p> /div> /div> /section> /div> div classdoc-examples> h5>Response Content-Types: span>application/json/span> /h5> section> h5>Response Example span>(200 OK)/span> /h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>true/span>, span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>}/code>/pre> !-- /div> --> /section> section> h5>Response Example span>(400 Bad Request)/span> /h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>false/span>, span classhljs-attr>"error"/span>: span classhljs-literal>true/span>, span classhljs-attr>"message"/span>: span classhljs-string>"X-Api-Key header is required"/span>}/code>/pre> !-- /div> --> /section> section> h5>Response Example span>(404 Not Found)/span> /h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>false/span>, span classhljs-attr>"error"/span>: span classhljs-literal>true/span>, span classhljs-attr>"message"/span>: span classhljs-string>"Not Found"/span>}/code>/pre> !-- /div> --> /section> /div> /div> div classdoc-row> div classdoc-copy> section classswagger-request-security> table classtable> thead> tr> th classswagger-request-security-schema>/th> th classswagger-request-security-scopes>/th> /tr> /thead> tbody> tr> td> a href#security-definition-ApiKeyAuth>ApiKeyAuth/a> /td> td> /td> /tr> /tbody> /table> /section> /div> /div> /div> h1>Schema Definitions/h1> div iddefinition-AddLead classdefinition panel data-traverse-targetdefinition-AddLead> h2 classpanel-title> a name/definitions/AddLead>/a>AddLead: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-description> p>The payload structure for a new lead submission. New leads can be sent in a POST request and must have a unique email address and leadType./p> /section> section classjson-schema-properties> dl> dt data-property-namepartnerName classhas-description> span classjson-property-name>partnerName:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> span classjson-property-required>/span> /dt> dd> p>The partner or CRM name sending this lead/p> /dd> dt data-property-namelead> span classjson-property-name>lead:/span> span classjson-property-type> span class> a classjson-schema-ref href#/definitions/Lead>Lead/a> /span> /span> span classjson-property-range titleValue limits>/span> span classjson-property-required>/span> /dt> dt data-property-namesearchAlert> span classjson-property-name>searchAlert:/span> span classjson-property-type> span class> a classjson-schema-ref href#/definitions/SearchAlert>SearchAlert/a> /span> /span> span classjson-property-range titleValue limits>/span> /dt> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"partnerName"/span>: span classhljs-string>"Leads, INC"/span>, span classhljs-attr>"lead"/span>: { span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"johnsmith@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"5555555555"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1"/span>, span classhljs-attr>"crmUrl"/span>: span classhljs-string>"https://some-crm-url.com/1"/span>, span classhljs-attr>"crmCreatedAt"/span>: span classhljs-string>"2017-04-14T18:31:19.000Z"/span>, span classhljs-attr>"deleted"/span>: span classhljs-literal>false/span>, span classhljs-attr>"source"/span>: span classhljs-string>"Google"/span>, span classhljs-attr>"leadType"/span>: span classhljs-string>"BUYER"/span>, span classhljs-attr>"status"/span>: span classhljs-string>"New"/span>, span classhljs-attr>"firstName"/span>: span classhljs-string>"John"/span>, span classhljs-attr>"middleName"/span>: span classhljs-string>"Jacob"/span>, span classhljs-attr>"lastName"/span>: span classhljs-string>"Smith"/span>, span classhljs-attr>"tags"/span>: span classhljs-string>"HOT"/span> , span classhljs-attr>"assignments"/span>: { span classhljs-attr>"type"/span>: span classhljs-string>"realtor"/span>, span classhljs-attr>"name"/span>: span classhljs-string>"Bob Realtor"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1234"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"bobrealtor@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"555-555-5555"/span> } , span classhljs-attr>"additionalData"/span>: { span classhljs-attr>"someString"/span>: span classhljs-string>"TEST"/span>, span classhljs-attr>"someCount"/span>: span classhljs-number>5/span>, span classhljs-attr>"someArray"/span>: span classhljs-string>"TEST1"/span>, span classhljs-string>"TEST2"/span> } }, span classhljs-attr>"searchAlert"/span>: { span classhljs-attr>"locations"/span>: { span classhljs-attr>"city"/span>: span classhljs-string>"Venice"/span>, span classhljs-attr>"state"/span>: span classhljs-string>"CA"/span> }, { span classhljs-attr>"county"/span>: span classhljs-string>"Los Angeles"/span>, span classhljs-attr>"state"/span>: span classhljs-string>"CA"/span> }, { span classhljs-attr>"postalCode"/span>: span classhljs-string>"90210"/span> } , span classhljs-attr>"minPrice"/span>: span classhljs-number>50000/span>, span classhljs-attr>"maxPrice"/span>: span classhljs-number>500000/span>, span classhljs-attr>"bathrooms"/span>: span classhljs-number>2/span>, span classhljs-attr>"bedrooms"/span>: span classhljs-number>4/span> }}/code>/pre> !-- /div> --> /section> /div> /div> /div> div iddefinition-UpdateLead classdefinition panel data-traverse-targetdefinition-UpdateLead> h2 classpanel-title> a name/definitions/UpdateLead>/a>UpdateLead: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-description> p>The payload structure for an update lead submission. Existing leads can be updated in a PUT request and are identified by either their email or uuid (as returned from any previously successful POST or PUT request)./p> /section> section classjson-schema-properties> dl> dt data-property-namelead> span classjson-property-name>lead:/span> span classjson-property-type> span class> a classjson-schema-ref href#/definitions/Lead>Lead/a> /span> /span> span classjson-property-range titleValue limits>/span> span classjson-property-required>/span> /dt> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"lead"/span>: { span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"johnsmith@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"5555555555"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1"/span>, span classhljs-attr>"crmUrl"/span>: span classhljs-string>"https://some-crm-url.com/1"/span>, span classhljs-attr>"crmCreatedAt"/span>: span classhljs-string>"2017-04-14T18:31:19.000Z"/span>, span classhljs-attr>"deleted"/span>: span classhljs-literal>false/span>, span classhljs-attr>"source"/span>: span classhljs-string>"Google"/span>, span classhljs-attr>"leadType"/span>: span classhljs-string>"BUYER"/span>, span classhljs-attr>"status"/span>: span classhljs-string>"New"/span>, span classhljs-attr>"firstName"/span>: span classhljs-string>"John"/span>, span classhljs-attr>"middleName"/span>: span classhljs-string>"Jacob"/span>, span classhljs-attr>"lastName"/span>: span classhljs-string>"Smith"/span>, span classhljs-attr>"tags"/span>: span classhljs-string>"HOT"/span> , span classhljs-attr>"assignments"/span>: { span classhljs-attr>"type"/span>: span classhljs-string>"realtor"/span>, span classhljs-attr>"name"/span>: span classhljs-string>"Bob Realtor"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1234"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"bobrealtor@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"555-555-5555"/span> } , span classhljs-attr>"additionalData"/span>: { span classhljs-attr>"someString"/span>: span classhljs-string>"TEST"/span>, span classhljs-attr>"someCount"/span>: span classhljs-number>5/span>, span classhljs-attr>"someArray"/span>: span classhljs-string>"TEST1"/span>, span classhljs-string>"TEST2"/span> } }}/code>/pre> !-- /div> --> /section> /div> /div> /div> div iddefinition-Lead classdefinition panel data-traverse-targetdefinition-Lead> h2 classpanel-title> a name/definitions/Lead>/a>Lead: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-description> p>A lead is a potential buyer or seller of real estate./p> /section> section classjson-schema-properties> dl> dt data-property-nameuuid classhas-description> span classjson-property-name>uuid:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The Ylopo unique identifier for use in lead PUT requests/p> /dd> dt data-property-nameemail classhas-description> span classjson-property-name>email:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> span classjson-property-required>/span> /dt> dd> p>The email address/p> /dd> dt data-property-namephone classhas-description> span classjson-property-name>phone:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The phone number/p> /dd> dt data-property-namecrmId classhas-description> span classjson-property-name>crmId:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The unique identifier in the CRM/p> /dd> dt data-property-namecrmUrl classhas-description> span classjson-property-name>crmUrl:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The URL to access the lead in the CRM/p> /dd> dt data-property-namecrmCreatedAt classhas-description> span classjson-property-name>crmCreatedAt:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The date (ISO 8601 format) the lead was created in the CRM/p> /dd> dt data-property-namedeleted classhas-description> span classjson-property-name>deleted:/span> span classjson-property-type>boolean/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>A flag to indicate that the lead has been deleted in the CRM/p> /dd> dt data-property-namesource classhas-description> span classjson-property-name>source:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The source or name of the service where the lead originated/p> /dd> dt data-property-nameleadType classhas-description> span classjson-property-name>leadType:/span> span classjson-property-type>string/span> span classjson-property-enum titlePossible values> span classjson-property-enum-item>BUYER/span>, span classjson-property-enum-item>SELLER/span>, span classjson-property-enum-item>REFINANCE/span> /span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The type of lead/p> /dd> dt data-property-namestatus classhas-description> span classjson-property-name>status:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The status in the CRM/p> /dd> dt data-property-namefirstName classhas-description> span classjson-property-name>firstName:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The first name/p> /dd> dt data-property-namemiddleName classhas-description> span classjson-property-name>middleName:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The middle name/p> /dd> dt data-property-namelastName classhas-description> span classjson-property-name>lastName:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The last name/p> /dd> dt data-property-nametags classhas-description> span classjson-property-name>tags:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The tags applied to the lead/p> /dd> dt classjson-inner-schema> section classjson-schema-array-items> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> div classjson-inner-schema> /div> /section> /dt> dt data-property-nameassignments classhas-description> span classjson-property-name>assignments:/span> span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The agents assigned to this lead, type as well as any of name, crmId, email, or phone are required/p> /dd> dt classjson-inner-schema> section classjson-schema-array-items> span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> div classjson-inner-schema> section classjson-schema-properties> dl> dt data-property-nametype classhas-description> span classjson-property-name>type:/span> span classjson-property-type>string/span> span classjson-property-enum titlePossible values> span classjson-property-enum-item>realtor/span>, span classjson-property-enum-item>lender/span> /span> span classjson-property-range titleValue limits>/span> span classjson-property-required>/span> /dt> dd> p>The type of assignment/p> /dd> dt data-property-namename classhas-description> span classjson-property-name>name:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The name of the assigned agent/p> /dd> dt data-property-namecrmId classhas-description> span classjson-property-name>crmId:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The crmId of the assigned agent/p> /dd> dt data-property-nameemail classhas-description> span classjson-property-name>email:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The email of the assigned agent/p> /dd> dt data-property-namephone classhas-description> span classjson-property-name>phone:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The phone number of the assigned agent/p> /dd> /dl> /section> /div> /section> /dt> dt data-property-nameadditionalData classhas-description> span classjson-property-name>additionalData:/span> span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>A flexible value store for any additional lead data you want to send. Must be a single-level object with each individual item being either a primitive or an Array of primitives./p> /dd> dt classjson-inner-schema> section classjson-schema-properties> dl> dt data-property-namefoo> span classjson-property-name>foo:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dt data-property-namebar> span classjson-property-name>bar:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dt classjson-inner-schema> section classjson-schema-array-items> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> div classjson-inner-schema> /div> /section> /dt> /dl> /section> /dt> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"johnsmith@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"5555555555"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1"/span>, span classhljs-attr>"crmUrl"/span>: span classhljs-string>"https://some-crm-url.com/1"/span>, span classhljs-attr>"crmCreatedAt"/span>: span classhljs-string>"2017-04-14T18:31:19.000Z"/span>, span classhljs-attr>"deleted"/span>: span classhljs-literal>false/span>, span classhljs-attr>"source"/span>: span classhljs-string>"Google"/span>, span classhljs-attr>"leadType"/span>: span classhljs-string>"BUYER"/span>, span classhljs-attr>"status"/span>: span classhljs-string>"New"/span>, span classhljs-attr>"firstName"/span>: span classhljs-string>"John"/span>, span classhljs-attr>"middleName"/span>: span classhljs-string>"Jacob"/span>, span classhljs-attr>"lastName"/span>: span classhljs-string>"Smith"/span>, span classhljs-attr>"tags"/span>: span classhljs-string>"HOT"/span> , span classhljs-attr>"assignments"/span>: { span classhljs-attr>"type"/span>: span classhljs-string>"realtor"/span>, span classhljs-attr>"name"/span>: span classhljs-string>"Bob Realtor"/span>, span classhljs-attr>"crmId"/span>: span classhljs-string>"1234"/span>, span classhljs-attr>"email"/span>: span classhljs-string>"bobrealtor@ylopo.com"/span>, span classhljs-attr>"phone"/span>: span classhljs-string>"555-555-5555"/span> } , span classhljs-attr>"additionalData"/span>: { span classhljs-attr>"someString"/span>: span classhljs-string>"TEST"/span>, span classhljs-attr>"someCount"/span>: span classhljs-number>5/span>, span classhljs-attr>"someArray"/span>: span classhljs-string>"TEST1"/span>, span classhljs-string>"TEST2"/span> }}/code>/pre> !-- /div> --> /section> /div> /div> /div> div iddefinition-SearchAlert classdefinition panel data-traverse-targetdefinition-SearchAlert> h2 classpanel-title> a name/definitions/SearchAlert>/a>SearchAlert: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-description> p>Only applicable for POST requests when creating new leads. If included, an initial search alert will be set up to regularly send the given lead email updates for new and updated listings that match the given criteria. This criteria will automatically be adjusted with more appropriate parameters based on the the lead's engagement./p> /section> section classjson-schema-properties> dl> dt data-property-namelocations classhas-description> span classjson-property-name>locations:/span> span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> span classjson-property-required>/span> /dt> dd> p>The inclusive locations to use for the search alert. There can be multiple, but least one is required./p> /dd> dt classjson-inner-schema> section classjson-schema-array-items> span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> div classjson-inner-schema> section classjson-schema-properties> dl> dt data-property-namecity classhas-description> span classjson-property-name>city:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>A city to use for the search alert. If provided, state is also required./p> /dd> dt data-property-namecounty classhas-description> span classjson-property-name>county:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>A county to use for the search alert. If provided, state is also required./p> /dd> dt data-property-namestate classhas-description> span classjson-property-name>state:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>A state to use for the search alert. If provided, state or county is also required./p> /dd> dt data-property-namepostalCode classhas-description> span classjson-property-name>postalCode:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>A postal code to use for the search alert, can be provided alongside or instead of city and state./p> /dd> /dl> /section> /div> /section> /dt> dt data-property-nameminPrice classhas-description> span classjson-property-name>minPrice:/span> span classjson-property-type>integer/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The minimum price to use for the search alert/p> /dd> dt data-property-namemaxPrice classhas-description> span classjson-property-name>maxPrice:/span> span classjson-property-type>integer/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The maximum price to use for the search alert/p> /dd> dt data-property-namebathrooms classhas-description> span classjson-property-name>bathrooms:/span> span classjson-property-type>integer/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The minimum number of bathrooms to use for the search alert/p> /dd> dt data-property-namebedrooms classhas-description> span classjson-property-name>bedrooms:/span> span classjson-property-type>integer/span> span classjson-property-range titleValue limits>/span> /dt> dd> p>The minimum number of bedrooms to use for the search alert/p> /dd> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"locations"/span>: { span classhljs-attr>"city"/span>: span classhljs-string>"Venice"/span>, span classhljs-attr>"state"/span>: span classhljs-string>"CA"/span> }, { span classhljs-attr>"county"/span>: span classhljs-string>"Los Angeles"/span>, span classhljs-attr>"state"/span>: span classhljs-string>"CA"/span> }, { span classhljs-attr>"postalCode"/span>: span classhljs-string>"90210"/span> } , span classhljs-attr>"minPrice"/span>: span classhljs-number>50000/span>, span classhljs-attr>"maxPrice"/span>: span classhljs-number>500000/span>, span classhljs-attr>"bathrooms"/span>: span classhljs-number>2/span>, span classhljs-attr>"bedrooms"/span>: span classhljs-number>4/span>}/code>/pre> !-- /div> --> /section> /div> /div> /div> div iddefinition-LeadAcceptedResponse classdefinition panel data-traverse-targetdefinition-LeadAcceptedResponse> h2 classpanel-title> a name/definitions/LeadAcceptedResponse>/a>LeadAcceptedResponse: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-properties> dl> dt data-property-namesuccess> span classjson-property-name>success:/span> span classjson-property-type>boolean/span> span classjson-property-range titleValue limits>/span> /dt> dt data-property-nameuuid> span classjson-property-name>uuid:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>true/span>, span classhljs-attr>"uuid"/span>: span classhljs-string>"3e0adfb9-ce2d-44d9-ad43-515dea9d22e9"/span>}/code>/pre> !-- /div> --> /section> /div> /div> /div> div iddefinition-BadRequestResponse classdefinition panel data-traverse-targetdefinition-BadRequestResponse> h2 classpanel-title> a name/definitions/BadRequestResponse>/a>BadRequestResponse: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-properties> dl> dt data-property-namesuccess> span classjson-property-name>success:/span> span classjson-property-type>boolean/span> span classjson-property-range titleValue limits>/span> /dt> dt data-property-nameerror> span classjson-property-name>error:/span> span classjson-property-type>boolean/span> span classjson-property-range titleValue limits>/span> /dt> dt data-property-namemessage> span classjson-property-name>message:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>false/span>, span classhljs-attr>"error"/span>: span classhljs-literal>true/span>, span classhljs-attr>"message"/span>: span classhljs-string>"X-Api-Key header is required"/span>}/code>/pre> !-- /div> --> /section> /div> /div> /div> div iddefinition-NotFoundResponse classdefinition panel data-traverse-targetdefinition-NotFoundResponse> h2 classpanel-title> a name/definitions/NotFoundResponse>/a>NotFoundResponse: object !-- span classjson-property-type>span classjson-property-type>object/span> span classjson-property-range titleValue limits>/span> /span> --> /h2> div classdoc-row> div classdoc-copy> section classjson-schema-properties> dl> dt data-property-namesuccess> span classjson-property-name>success:/span> span classjson-property-type>boolean/span> span classjson-property-range titleValue limits>/span> /dt> dt data-property-nameerror> span classjson-property-name>error:/span> span classjson-property-type>boolean/span> span classjson-property-range titleValue limits>/span> /dt> dt data-property-namemessage> span classjson-property-name>message:/span> span classjson-property-type>string/span> span classjson-property-range titleValue limits>/span> /dt> /dl> /section> /div> div classdoc-examples> section> h5>Example/h5> !-- div classhljs> -->pre>code classhljs lang-json>{ span classhljs-attr>"success"/span>: span classhljs-literal>false/span>, span classhljs-attr>"error"/span>: span classhljs-literal>true/span>, span classhljs-attr>"message"/span>: span classhljs-string>"Not Found"/span>}/code>/pre> !-- /div> --> /section> /div> /div> /div> div classdoc-row no-margin> div classdoc-copy doc-separator> a classpowered-by hrefhttps://sourcey.com/spectacle>Documentation by span>Spectacle/span> /a> /div> /div> /article> /div> /div> /body>/html>

Subdomains

Date	Domain	IP
knowledgebase.ylopo.com	2024-09-03	13.224.14.72
portal.ylopo.com	2025-10-02	44.229.192.134
demo.ylopo.com	2025-08-19	172.67.68.114
api-docs.ylopo.com	2025-11-17	52.92.162.211
www.ylopo.com	2025-10-29	198.185.159.145

View on OTX | View on ThreatMiner

Data with thanks to AlienVault OTX, VirusTotal, Malwr and others. [Sitemap]

Domain > api-docs.ylopo.com

Is this malicious?

DNS Resolutions

Port 80

Subdomains