---
title: "Create a smart link (BETA) (v1)"
method: POST
path: "/api/v1/properties/smart-links"
tags: ["api---properties"]
---

# Create a smart link (BETA) (v1)

`POST /api/v1/properties/smart-links`

## Request

- Base URL: `https://api.casafari.com`
- URL: `https://api.casafari.com/api/v1/properties/smart-links`
- Auth: HTTP bearer

Generates a smart link that provides detailed property information
    with customizable components, branding, and user/company information overrides.

## Request body

- ApiCreateSmartLinkRequestV1
  - `primary_listing_ids` integer[], required: List of primary listing ids to include in the smart link.
  - `settings` object, required
    - `is_indexing_by_search_engine` boolean: Determines whether a share page should be indexed by search engines.
    - `is_hide_source` boolean: Removes the "Sourced by Casafari" label from the Smartlink page.
    - `language` 'en' | 'fr' | 'it' | 'pt' | 'es' | 'de', required: Language of the share page.
    - `brand_color` string: Main color of graphical elements in the report.
    - `components_to_include` string[]: List of components to include in the smart link.
  - `user` object, required
    - `first_name` string, required
    - `last_name` string, required
    - `email` string, email, required
    - `phone` string, required
    - `photo_url` string, uri
    - `about_me` string
  - `company` object
    - `name` string, required
    - `logo_url` string, uri

## Response `200`

- ApiCreateSmartLinkResponseV1
  - `id` string, required
  - `url` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/casafari/apis/casafari-api.md) · [All operations](https://skmtc.dev/casafari/apis/casafari-api/llms.txt) · [OpenAPI document](https://skmtc.dev/casafari/apis/casafari-api/revisions/6743b99d4bf9?raw)