---
title: "Update Site Survey Overview"
method: PUT
path: "/tenants/{tenant_id}/site_surveys/{site_survey_id}"
tags: ["Site Surveys"]
---

# Update Site Survey Overview

`PUT /tenants/{tenant_id}/site_surveys/{site_survey_id}`

## Request

- Base URL: `https://api-sandbox.aurorasolar.com`
- URL: `https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/site_surveys/{site_survey_id}`
- Auth: HTTP bearer

Updates the overview of a site survey.

---

[block:callout]
{
"type": "warning",
"body": "Please note that the Site Surveys API is in beta. As a beta product, the API will not be supported via our normal support channels. You may also experience some gaps and changes as the product is refined and documentation is updated before general release."
}
[/block]


This endpoint is used to update metadata and overview attributes on a site survey.

Currently the only allowed overview field is `notes`.

To update other site survey attribtues, see:
- [Update Site Survey Electrical Data](ref:updatesitesurveyelectricaldata)
- [Update Site Survey Electrical Subpanels](ref:updatesitesurveyelectricalsubpanels)
- [Update Site Survey Mounting Planes](ref:updatesitesurveymountingplanes)
- [Update Site Survey Status](ref:updatesitesurveystatus)

## Path parameters

- `tenant_id` string, uuid, required
- `site_survey_id` string, uuid, required

## Request body

- object
  - `site_survey` object, required
    - `report` object: PDF report to associate with the site survey
      - `url` string, uri, required: URL of the report. If the filename field is not provided, the URL must contain a filename with a `.pdf` extension
      - `filename` string: The filename of the report. It must have a `.pdf` extension
    - `notes` string: Overall notes for the site survey.
    - `images` object[]: List of images to associate with the site survey
      - `url` string, uri, required: URL of the image. If the filename field is not provided, the URL must contain a filename with one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
      - `filename` string: The filename of the image that uses one of the following extensions: .jpg, .jpeg, .png, .gif, .webp

## Response `200`

Overview successfully updated.

- object
  - `site_survey` object, required
    - `report` object: PDF report to associate with the site survey
      - `url` string, uri, required: URL of the report. If the filename field is not provided, the URL must contain a filename with a `.pdf` extension
      - `filename` string: The filename of the report. It must have a `.pdf` extension
    - `notes` string: Overall notes for the site survey.
    - `images` object[]: List of images to associate with the site survey
      - `url` string, uri, required: URL of the image. If the filename field is not provided, the URL must contain a filename with one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
      - `filename` string: The filename of the image that uses one of the following extensions: .jpg, .jpeg, .png, .gif, .webp

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity

## Changes

- **2026-11-03** `97a7ad8a993a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/aurorasolar/apis/sync-api/changes/tenants/:tenant_id/site_surveys/:site_survey_id/put.md)

---

[API](https://skmtc.dev/aurorasolar/apis/sync-api.md) - [All operations](https://skmtc.dev/aurorasolar/apis/sync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aurorasolar/apis/sync-api/revisions/97a7ad8a993a?raw)