Docs
Update Surface
PUT /surfaces/{surfaceId}
PUT
/surfaces/{surfaceId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Updates all editable fields on an existing surface.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| surfaceId | Guid | Required | The ID of the surface to update. Replace `{{surfaceId}}` in the URL. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | New display name. |
| description | string | Optional | Updated description. |
| rasterMapId | Guid? | Optional | Updated raster map link. Pass `null` to unlink. |
| areaId | Guid? | Optional | Updated area scope. Pass `null` to remove scoping. |
| exactLocation | string | Optional | Updated physical location description. |
Response
Returns 200 OK with an empty body on success.