---
title: "Onboard Property"
method: POST
path: "/api/v1/report-ai/properties/onboard"
tags: ["report-ai", "properties"]
---

# Onboard Property

`POST /api/v1/report-ai/properties/onboard`

Onboard a property from a Google Place ID — auto-derives all metadata.

## Request body

- PropertyOnboardRequest — Request to onboard a property from a Google Place ID.
  - `google_place_id` string, required
  - `code` string, required
  - `name` string, nullable
  - `currency` string, nullable

## Response `200`

Successful Response

- PropertyRead — Schema for reading a Property.
  - `id` string, uuid, required
  - `code` string, required
  - `name` string, required
  - `latitude` number, nullable
  - `longitude` number, nullable
  - `timezone` string, nullable
  - `country_code` string, nullable
  - `currency` string, required
  - `created_at` string, date-time, required
  - `google_place_id` string, nullable
  - `address` string, nullable
  - `star_rating` number, nullable
  - `review_count` integer, nullable
  - `website_url` string, nullable
  - `property_type` string, nullable
  - `city` string, nullable
  - `positioning_tags` string[]
  - `source_tracker_region_slug` string, nullable

## Other responses

- `403` — Missing the required permission
- `409` — Duplicate property (code or Google Place ID already exists)
- `422` — Could not determine country from address
- `502` — Failed to fetch property details from Google

---

[API](https://skmtc.dev/getanana/apis/cleon-api.md) · [All operations](https://skmtc.dev/getanana/apis/cleon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getanana/cleon-api/revisions/a9141b6e4e7e/schema)