API Reference

Update Site Survey Status

Updates status for a site survey.


🚧

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.

This endpoint is used to transition a site survey from one status to another, and validates conditions for that transition.

Currently the only allowed status transition is from in-progress to completed, with the follow validations:

  • electrical.main_panel_location is filled out.
  • electrical.main_bus_rating is filled out.
  • electrical.main_breaker_rating is filled out.
  • For each mounting plane in roofs.mounting_plane:
    • pitch is filled out.
    • azimuth is filled out.
    • roof_type is filled out.
    • framing_type is filled out.
    • rafter_size is filled out.
    • rafter_spacing is filled out.
Language
Credentials
Bearer
header
Click Try It! to start a request and see the response here!