/organizations/{organization_id}/sites/{site_id}

Beta Notice: This is a pre-release beta endpoint. It is subject to change without notice and has no uptime guarantee.

Partially updates an existing site.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the organization

string
required

Unique identifier for a site

Body Params

Payload for partially updating a single site.

coordinate_reference_system_pointer
object

Identifier for the site's coordinate reference system. Use this to switch to a different published coordinate reference system, or from the default to a Local Site Calibration once the calibration file has been uploaded.

A Local Site Calibration is created through the uploads endpoint as a LOCAL_CALIBRATION upload. Once the upload is complete, its id can be found in the upload's created_entities. Reference it with the same id in both CRS components and authority set to PROP-LOCAL, for example:

{
  "horizontal": {"authority": "PROP-LOCAL", "id": "sc1234abcd"},
  "vertical": {"authority": "PROP-LOCAL", "id": "sc1234abcd"}
}

Warning: Changing an existing coordinate reference system has consequences:

  • Future data will be processed using the new coordinate reference system.
  • Existing datasets and design files are not converted automatically. They may no longer align or may appear in the wrong location or elevation.
  • Reprocess existing surveys and re-upload designs after the change to keep site data aligned.
string | null

The industry identifier (accepted as a bare string on input; returned as {'id': ''} on output). Valid identifiers can be listed via GET /industries.

string
length between 1 and 100

The name of the site

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json