> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sitevisit.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a property

> Create a property on the authenticated user's account. Returns 402 with an upgrade URL when the user's plan property limit is reached.



## OpenAPI

````yaml /api-reference/openapi.json post /properties
openapi: 3.1.0
info:
  title: SiteVisit AI API
  version: 1.0.0
  description: >-
    Public REST API for SiteVisit AI. Read and write properties, site visits,
    and action items from your account. 


    ## Authentication


    Authenticate with a `Bearer sv_live_...` token issued in Settings →
    Developers. Two key modes are supported:


    - **Live keys (`sv_live_*`)** — operate on your real customer data. Counts
    against plan limits, fires real webhooks + PostHog activation events.

    - **Test keys (`sv_test_*`)** — operate on a parallel sandbox dataset (every
    resource is tagged `isTest=true`). Test data is free + unmetered, never
    counts against plan limits, and never crosses into live data. Use for
    development + integration testing without touching production.


    Test-mode webhook endpoints (configured with `mode=test` in the Settings UI)
    only receive events triggered by test keys; live endpoints only receive live
    events. Webhook payloads include a `livemode: bool` flag so receivers can
    branch without parsing the resource.
  contact:
    name: SiteVisit AI Support
    email: support@sitevisit.app
servers:
  - url: https://sitevisit.app/api/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /properties:
    post:
      summary: Create a property
      description: >-
        Create a property on the authenticated user's account. Returns 402 with
        an upgrade URL when the user's plan property limit is reached.
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: Display name of the property.
                address:
                  type: string
                  maxLength: 500
                  description: Optional street address.
                notes:
                  type: string
                  maxLength: 5000
                  description: Optional free-form notes (markdown allowed).
                icon_emoji:
                  type: string
                  maxLength: 8
                  description: Optional emoji shown on the property card.
              required:
                - name
              additionalProperties: false
      responses:
        '201':
          description: Resource created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property'
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: >-
            Plan limit reached. Response includes upgrade_url and current plan
            info.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanLimitErrorResponse'
        '409':
          description: Another request with the same Idempotency-Key is still in flight.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Idempotency-Key already used with a different request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optional idempotency key, scoped to the authenticated account. Repeating
        a write with the same key + same body returns the original response;
        same key + different body returns 422 idempotency_key_in_use.
      schema:
        type: string
        maxLength: 255
  schemas:
    Property:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        address:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        iconEmoji:
          type:
            - string
            - 'null'
        coverImageUrl:
          type:
            - string
            - 'null'
        isSample:
          type: boolean
        isTest:
          type: boolean
          description: >-
            True for objects created via a `sv_test_*` API key. Stripe-style
            test-mode flag — test data is never returned to live-mode callers
            and vice versa.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        visitCount:
          type: integer
        openItemCount:
          type: integer
      required:
        - id
        - name
        - isSample
        - isTest
        - createdAt
        - updatedAt
        - visitCount
        - openItemCount
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_api_key
            message:
              type: string
              example: The API key provided is invalid, revoked, or doesn't exist.
            docs_url:
              type: string
              format: uri
            request_id:
              type: string
              example: req_abc123
          required:
            - code
            - message
            - docs_url
            - request_id
      required:
        - error
    PlanLimitErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: plan_limit_exceeded
            message:
              type: string
            docs_url:
              type: string
              format: uri
            request_id:
              type: string
            upgrade_url:
              type: string
              format: uri
              example: https://sitevisit.app/settings#upgrade
            current_plan:
              type: string
              example: free
            used:
              type: integer
              example: 1
            limit:
              type: integer
              example: 1
          required:
            - code
            - message
            - docs_url
            - request_id
            - upgrade_url
            - current_plan
            - used
            - limit
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sv_live_xxx (or sv_test_xxx for sandbox mode)
      description: >-
        Bearer API key. Two modes: `sv_live_*` for production data, `sv_test_*`
        for a parallel sandbox dataset that doesn't count against plan limits.
        Issued from Settings → Developers in the SiteVisit app.

````