API Reference

/organizations/{organization_id}/sites/{site_id}/workspaces/{workspace_id}/shapes/{shape_id}

patch
https://api.propelleraero.com/v1/organizations//sites//workspaces//shapes/

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

Updates a shape by its unique identifier. Only the fields provided in the request body are changed.

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

ID of the site

string
required

ID of the workspace

string
required

ID of the shape

Query Params
string
enum
Defaults to site

Coordinate system for returned geometry. Defaults to "site" (the site's local coordinate system). Use "wgs84" to return coordinates in WGS 84.

Allowed:
Body Params

Request body for updating a shape. Include only the fields you want to change — any field left out keeps its current value. Sending an empty body is not allowed.

string | null

The id of the dataset this shape belongs to. Set to null to move the shape to site level (visible across all datasets on the site).

string
enum

The source of a shape or measurement

Allowed:
styled_geometry

The shape's geometry and visual styling (fill/stroke colours, labels, icons). Coordinates must be in the site's local CRS.

string

The shape's display name.

Responses

Updated 1 day ago

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

Updated 1 day ago