Skip to main content
PATCH
Update matching locations

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json
parentId
string<uuid> | null
name
string
code
string | null
type
enum<string>
Available options:
storage,
staging,
in_transit,
yard,
build_bay,
station,
rack,
bay,
booth,
cell,
shelf,
zone,
work_center,
site
metadata
object
addressLine1
string | null
addressLine2
string | null
city
string | null
stateOrProvince
string | null
postalCode
string | null
country
enum<string> | null
Available options:
US,
CA
latitude
number | null
longitude
number | null
timezone
string | null
deliveryInstructions
string | null
notes
string | null
isArchived
enum<boolean>
Available options:
false

Response

Successful response.

values
object[]