> ## 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.

# Update a site visit

> Patch any subset of (title, visit_date, summary, notes). Status transitions are driven by the video pipeline and aren't editable via the API. To close a visit use POST /site-visits/{id}/complete instead.



## OpenAPI

````yaml /api-reference/openapi.json patch /site-visits/{id}
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:
  /site-visits/{id}:
    patch:
      summary: Update a site visit
      description: >-
        Patch any subset of (title, visit_date, summary, notes). Status
        transitions are driven by the video pipeline and aren't editable via the
        API. To close a visit use POST /site-visits/{id}/complete instead.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  maxLength: 200
                visit_date:
                  type: string
                  format: date-time
                  description: ISO 8601 timestamp.
                summary:
                  type:
                    - string
                    - 'null'
                  maxLength: 10000
                notes:
                  type:
                    - string
                    - 'null'
                  maxLength: 10000
              additionalProperties: false
      responses:
        '200':
          description: Resource updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteVisit'
        '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'
        '404':
          description: Referenced resource does not exist or is not owned by this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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:
    SiteVisit:
      type: object
      properties:
        id:
          type: string
        propertyId:
          type: string
        propertyName:
          type: string
        title:
          type: string
        status:
          type: string
          enum:
            - DRAFT
            - PROCESSING
            - READY
            - SENT
            - DONE
        visitDate:
          type: string
          format: date-time
        summary:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        recipients:
          type: array
          items:
            type: string
        isTest:
          type: boolean
          description: >-
            True for objects created via a `sv_test_*` API key. Mirrors the
            parent Property's mode.
        sentAt:
          type:
            - string
            - 'null'
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        actionItemCount:
          type: integer
        openActionItemCount:
          type: integer
        publicReportUrl:
          type: string
          format: uri
      required:
        - id
        - propertyId
        - propertyName
        - title
        - status
        - visitDate
        - recipients
        - isTest
        - createdAt
        - updatedAt
        - actionItemCount
        - openActionItemCount
        - publicReportUrl
    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
  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.

````