Create a smart link (BETA) (v1)
POST
https://api.casafari.com/api/v1/properties/smart-linksBearer token17 parameters
Send Authorization: Bearer $CASAFARI_TOKEN; see how to get a token.
Over MCP: no tool does this. MCP and REST compared.
Description
Generates a smart link that provides detailed property information with customizable components, branding, and user/company information overrides.
Request body
Content type application/json. Optional. Type: object.
primary_listing_idsinteger[]requiredList of primary listing ids to include in the smart link.
1–10 items
settingsobjectrequired5 properties
is_indexing_by_search_enginebooleanDetermines whether a share page should be indexed by search engines.
default false
is_hide_sourcebooleanRemoves the "Sourced by Casafari" label from the Smartlink page.
default false
languagestringrequiredLanguage of the share page.
en fr it pt es debrand_colorstringMain color of graphical elements in the report.
at most 9 characters
components_to_includestring[]List of components to include in the smart link.
price days_on_market price_change sources history location_intelligence comparables valuation market_analyticsdefault ["price"]
userobjectrequired6 properties
first_namestringrequiredlast_namestringrequiredemailstring (email)requiredphonestringrequiredphoto_urlstring (uri)pattern
^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-0-9](?:[a-z¡-0-9-]{0,61}[a-z¡-0-9])?(?:\.(?!-)[a-z¡-0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡--]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\zabout_mestringcompanyobject2 properties
namestringrequiredlogo_urlstring (uri)pattern
^(?:[a-z0-9.+-]*)://(?:[^\s:@/]+(?::[^\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z¡-0-9](?:[a-z¡-0-9-]{0,61}[a-z¡-0-9])?(?:\.(?!-)[a-z¡-0-9-]{1,63}(?<!-))*\.(?!-)(?:[a-z¡--]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\s]*)?\zExample request
Placeholders only: replace the token and the values with your own.
curl -X POST "https://api.casafari.com/api/v1/properties/smart-links" \
-H "Authorization: Bearer $CASAFARI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"primary_listing_ids": [
111111111,
222222222
],
"settings": {
"brand_color": "#000000",
"language": "pt",
"is_indexing_by_search_engine": true,
"is_hide_source": true,
"components_to_include": [
"price",
"days_on_market",
"price_change",
"sources",
"history",
"location_intelligence",
"comparables",
"valuation",
"market_analytics"
]
},
"user": {
"first_name": "Test",
"last_name": "Test",
"email": "user@casafari.com",
"phone": "+111111111111",
"photo_url": "https://www.photos-cdn.com/user-photo.png",
"about_me": "about me text info"
},
"company": {
"name": "Company Name",
"logo_url": "https://www.photos-cdn.com/company-logo.png"
}
}'Responses
200 OK
Type: object.
Show the response shape (2 fields)
idstringrequiredurlstringrequiredExample from the API description
{
"id": "68d119290bc138b51fc58f4c",
"url": "https://www.casafari.com/estate/sharepage/68d119290bc138b51fc58f4c"
}401 Unauthorized
Type: object.
Show the response shape (1 fields)
detailstringDescription of the error encountered.
403 Forbidden
Type: object.
Show the response shape (1 fields)
detailstringDescription of the error encountered.