Bulk Upsert Sub-Location Types
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"types": [
{
"externalId": "FRIDGE",
"name": "Fridge",
"attributes": [
{
"externalId": "ZONE",
"name": "Zone",
"type": "single_select",
"options": [
{
"label": "Front",
"color": "#7C5CFC"
},
{
"label": "Back",
"color": "#22B8CF"
}
]
},
{
"externalId": "CAPACITY",
"name": "Capacity",
"type": "number"
}
]
}
]
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert"
payload = { "types": [
{
"externalId": "FRIDGE",
"name": "Fridge",
"attributes": [
{
"externalId": "ZONE",
"name": "Zone",
"type": "single_select",
"options": [
{
"label": "Front",
"color": "#7C5CFC"
},
{
"label": "Back",
"color": "#22B8CF"
}
]
},
{
"externalId": "CAPACITY",
"name": "Capacity",
"type": "number"
}
]
}
] }
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
types: [
{
externalId: 'FRIDGE',
name: 'Fridge',
attributes: [
{
externalId: 'ZONE',
name: 'Zone',
type: 'single_select',
options: [{label: 'Front', color: '#7C5CFC'}, {label: 'Back', color: '#22B8CF'}]
},
{externalId: 'CAPACITY', name: 'Capacity', type: 'number'}
]
}
]
})
};
fetch('https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'types' => [
[
'externalId' => 'FRIDGE',
'name' => 'Fridge',
'attributes' => [
[
'externalId' => 'ZONE',
'name' => 'Zone',
'type' => 'single_select',
'options' => [
[
'label' => 'Front',
'color' => '#7C5CFC'
],
[
'label' => 'Back',
'color' => '#22B8CF'
]
]
],
[
'externalId' => 'CAPACITY',
'name' => 'Capacity',
'type' => 'number'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert"
payload := strings.NewReader("{\n \"types\": [\n {\n \"externalId\": \"FRIDGE\",\n \"name\": \"Fridge\",\n \"attributes\": [\n {\n \"externalId\": \"ZONE\",\n \"name\": \"Zone\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Front\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Back\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"CAPACITY\",\n \"name\": \"Capacity\",\n \"type\": \"number\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"types\": [\n {\n \"externalId\": \"FRIDGE\",\n \"name\": \"Fridge\",\n \"attributes\": [\n {\n \"externalId\": \"ZONE\",\n \"name\": \"Zone\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Front\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Back\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"CAPACITY\",\n \"name\": \"Capacity\",\n \"type\": \"number\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"types\": [\n {\n \"externalId\": \"FRIDGE\",\n \"name\": \"Fridge\",\n \"attributes\": [\n {\n \"externalId\": \"ZONE\",\n \"name\": \"Zone\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Front\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Back\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"CAPACITY\",\n \"name\": \"Capacity\",\n \"type\": \"number\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"externalId": "FRIDGE",
"id": "5ea865b5-1503-4cc4-975d-101ecf67a5e4",
"name": "Fridge",
"status": "active",
"created": true,
"attributes": [
{
"externalId": "ZONE",
"id": "8b1d2c3e-4f50-4a61-8b72-93a4b5c6d7e8",
"key": "zone",
"name": "Zone",
"created": true
},
{
"externalId": "CAPACITY",
"id": "9c2e3d4f-5061-4b72-9c83-a4b5c6d7e8f9",
"key": "capacity",
"name": "Capacity",
"created": true
}
]
}
],
"extra_meta": {
"message": "Sub-location types upserted"
}
}Enterprise Sub-Locations
Bulk Upsert Sub-Location Types
Idempotently creates or updates sub-location types (e.g. Fridge, Auditorium) and their attribute definitions in one call, keyed by your own externalId. Safe to re-run.
Up to 100 types per call, 50 attributes per type, 100 options per select attribute.
Type identity, in priority order: externalId → id → name (case-insensitive). If nothing matches, the type is created. A matched type is renamed to name.
Attribute identity (within the type): externalId → id → key → name (case-insensitive). If nothing matches, the attribute is created and gets a key derived from its name (returned in the response). key is match-only: it must name an existing attribute of the type. An externalId already used by an attribute of another type is rejected, as are two attributes in one row that match the same existing attribute.
Additive only. Attributes and options you leave out are kept, never deleted. Options are matched by id, else by label (case-insensitive): a match is updated (label, color), anything else is appended.
type is immutable. Sending a different type for an existing attribute is rejected with 400.
The response reports each type’s status, so a match against a type archived in the web app is visible (sub-locations cannot be created under an archived type).
The call is all-or-nothing: if any row fails, nothing is written and the error message names the row (e.g. types[1].attributes[0]).
Requires the Public API workspace feature, CAN_MANAGE_LOCATIONS, and Sub-Locations enabled for the workspace (contact Xenia to enable it; until then every sub-location endpoint returns 404).
POST
/
api
/
v1
/
mgt
/
enterprise
/
workspaces
/
{workspaceId}
/
sub-location-types
/
bulk-upsert
Bulk Upsert Sub-Location Types
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"types": [
{
"externalId": "FRIDGE",
"name": "Fridge",
"attributes": [
{
"externalId": "ZONE",
"name": "Zone",
"type": "single_select",
"options": [
{
"label": "Front",
"color": "#7C5CFC"
},
{
"label": "Back",
"color": "#22B8CF"
}
]
},
{
"externalId": "CAPACITY",
"name": "Capacity",
"type": "number"
}
]
}
]
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert"
payload = { "types": [
{
"externalId": "FRIDGE",
"name": "Fridge",
"attributes": [
{
"externalId": "ZONE",
"name": "Zone",
"type": "single_select",
"options": [
{
"label": "Front",
"color": "#7C5CFC"
},
{
"label": "Back",
"color": "#22B8CF"
}
]
},
{
"externalId": "CAPACITY",
"name": "Capacity",
"type": "number"
}
]
}
] }
headers = {
"x-client-key": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-key': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
types: [
{
externalId: 'FRIDGE',
name: 'Fridge',
attributes: [
{
externalId: 'ZONE',
name: 'Zone',
type: 'single_select',
options: [{label: 'Front', color: '#7C5CFC'}, {label: 'Back', color: '#22B8CF'}]
},
{externalId: 'CAPACITY', name: 'Capacity', type: 'number'}
]
}
]
})
};
fetch('https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'types' => [
[
'externalId' => 'FRIDGE',
'name' => 'Fridge',
'attributes' => [
[
'externalId' => 'ZONE',
'name' => 'Zone',
'type' => 'single_select',
'options' => [
[
'label' => 'Front',
'color' => '#7C5CFC'
],
[
'label' => 'Back',
'color' => '#22B8CF'
]
]
],
[
'externalId' => 'CAPACITY',
'name' => 'Capacity',
'type' => 'number'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-key: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert"
payload := strings.NewReader("{\n \"types\": [\n {\n \"externalId\": \"FRIDGE\",\n \"name\": \"Fridge\",\n \"attributes\": [\n {\n \"externalId\": \"ZONE\",\n \"name\": \"Zone\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Front\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Back\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"CAPACITY\",\n \"name\": \"Capacity\",\n \"type\": \"number\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-key", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"types\": [\n {\n \"externalId\": \"FRIDGE\",\n \"name\": \"Fridge\",\n \"attributes\": [\n {\n \"externalId\": \"ZONE\",\n \"name\": \"Zone\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Front\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Back\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"CAPACITY\",\n \"name\": \"Capacity\",\n \"type\": \"number\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/sub-location-types/bulk-upsert")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-key"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"types\": [\n {\n \"externalId\": \"FRIDGE\",\n \"name\": \"Fridge\",\n \"attributes\": [\n {\n \"externalId\": \"ZONE\",\n \"name\": \"Zone\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Front\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Back\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"CAPACITY\",\n \"name\": \"Capacity\",\n \"type\": \"number\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"externalId": "FRIDGE",
"id": "5ea865b5-1503-4cc4-975d-101ecf67a5e4",
"name": "Fridge",
"status": "active",
"created": true,
"attributes": [
{
"externalId": "ZONE",
"id": "8b1d2c3e-4f50-4a61-8b72-93a4b5c6d7e8",
"key": "zone",
"name": "Zone",
"created": true
},
{
"externalId": "CAPACITY",
"id": "9c2e3d4f-5061-4b72-9c83-a4b5c6d7e8f9",
"key": "capacity",
"name": "Capacity",
"created": true
}
]
}
],
"extra_meta": {
"message": "Sub-location types upserted"
}
}Path Parameters
UUID of the workspace. Must be the workspace your API key is bound to.
Body
application/json
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Response
One result per input type, in request order, with one entry per input attribute.