Open Inventory / Docs
EndpointsSpatial roomsSpatial structuresStructureid

Update a structure's name or canonical map anchor

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

PATCH
/spatial-structures/{structureId}

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

structureId*string
Formatuuid

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
Properties1 <= properties
name?string
Length1 <= length <= 240
description?string
Lengthlength <= 10000
georeference?|null

Response Body

Structure updated

Example Request
curl -X PATCH 'https://inventory.example.com/api/v1/spatial-structures/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty

Retrieve active rooms grouped by floor and AR coordinate space GET

Previous Page

Retrieve one item's stock policy, forecast, units, and ledger GET

Next Page