Bulk Upsert Location Attributes
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/bulk-upsert \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"attributes": [
{
"externalId": "REGION",
"name": "Region",
"description": "Operational region",
"type": "single_select",
"options": [
{
"label": "Southwest",
"color": "#7C5CFC"
},
{
"label": "Midwest",
"color": "#22B8CF"
}
]
},
{
"externalId": "DRIVE_THRU_LANES",
"name": "Drive Thru Lanes",
"type": "number"
}
]
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/bulk-upsert"
payload = { "attributes": [
{
"externalId": "REGION",
"name": "Region",
"description": "Operational region",
"type": "single_select",
"options": [
{
"label": "Southwest",
"color": "#7C5CFC"
},
{
"label": "Midwest",
"color": "#22B8CF"
}
]
},
{
"externalId": "DRIVE_THRU_LANES",
"name": "Drive Thru Lanes",
"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({
attributes: [
{
externalId: 'REGION',
name: 'Region',
description: 'Operational region',
type: 'single_select',
options: [{label: 'Southwest', color: '#7C5CFC'}, {label: 'Midwest', color: '#22B8CF'}]
},
{externalId: 'DRIVE_THRU_LANES', name: 'Drive Thru Lanes', type: 'number'}
]
})
};
fetch('https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/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}/location-attributes/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([
'attributes' => [
[
'externalId' => 'REGION',
'name' => 'Region',
'description' => 'Operational region',
'type' => 'single_select',
'options' => [
[
'label' => 'Southwest',
'color' => '#7C5CFC'
],
[
'label' => 'Midwest',
'color' => '#22B8CF'
]
]
],
[
'externalId' => 'DRIVE_THRU_LANES',
'name' => 'Drive Thru Lanes',
'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}/location-attributes/bulk-upsert"
payload := strings.NewReader("{\n \"attributes\": [\n {\n \"externalId\": \"REGION\",\n \"name\": \"Region\",\n \"description\": \"Operational region\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Southwest\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Midwest\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"DRIVE_THRU_LANES\",\n \"name\": \"Drive Thru Lanes\",\n \"type\": \"number\"\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}/location-attributes/bulk-upsert")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attributes\": [\n {\n \"externalId\": \"REGION\",\n \"name\": \"Region\",\n \"description\": \"Operational region\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Southwest\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Midwest\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"DRIVE_THRU_LANES\",\n \"name\": \"Drive Thru Lanes\",\n \"type\": \"number\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/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 \"attributes\": [\n {\n \"externalId\": \"REGION\",\n \"name\": \"Region\",\n \"description\": \"Operational region\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Southwest\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Midwest\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"DRIVE_THRU_LANES\",\n \"name\": \"Drive Thru Lanes\",\n \"type\": \"number\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"externalId": "REGION",
"id": "1f6c9e0a-2b7d-4d5e-9a11-8c3f5b6d7e88",
"name": "Region",
"created": true
},
{
"externalId": "DRIVE_THRU_LANES",
"id": "2a7d0f1b-3c8e-4e6f-9b22-9d4a6c7e8f99",
"name": "Drive Thru Lanes",
"created": false
}
],
"extra_meta": {
"message": "Attributes upserted"
}
}Enterprise Locations
Bulk Upsert Location Attributes
Creates or updates up to 500 attribute definitions per call.
Identity resolution, in priority order: externalId (your key, recorded on first create so later runs resolve to the same attribute) → id (a Xenia UUID) → name. If nothing matches, the attribute is created.
type is immutable. It is required on every row; sending a type that conflicts with an existing attribute’s type is rejected with 400.
Options are required for single_select and multi_select and forbidden for the other four types. Options are replaced by exactly what you send: include an option’s id to keep it (renaming it that way preserves stored values), omit id to add a new one, and leave one out to remove it. Prefer additive option changes — removing an option through this endpoint can leave per-location values pointing at an option that no longer exists, so re-send values for the affected locations afterwards.
Requires the Public API and Location Attributes workspace features plus CAN_MANAGE_LOCATIONS.
POST
/
api
/
v1
/
mgt
/
enterprise
/
workspaces
/
{workspaceId}
/
location-attributes
/
bulk-upsert
Bulk Upsert Location Attributes
curl --request POST \
--url https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/bulk-upsert \
--header 'Content-Type: application/json' \
--header 'x-client-key: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"attributes": [
{
"externalId": "REGION",
"name": "Region",
"description": "Operational region",
"type": "single_select",
"options": [
{
"label": "Southwest",
"color": "#7C5CFC"
},
{
"label": "Midwest",
"color": "#22B8CF"
}
]
},
{
"externalId": "DRIVE_THRU_LANES",
"name": "Drive Thru Lanes",
"type": "number"
}
]
}
'import requests
url = "https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/bulk-upsert"
payload = { "attributes": [
{
"externalId": "REGION",
"name": "Region",
"description": "Operational region",
"type": "single_select",
"options": [
{
"label": "Southwest",
"color": "#7C5CFC"
},
{
"label": "Midwest",
"color": "#22B8CF"
}
]
},
{
"externalId": "DRIVE_THRU_LANES",
"name": "Drive Thru Lanes",
"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({
attributes: [
{
externalId: 'REGION',
name: 'Region',
description: 'Operational region',
type: 'single_select',
options: [{label: 'Southwest', color: '#7C5CFC'}, {label: 'Midwest', color: '#22B8CF'}]
},
{externalId: 'DRIVE_THRU_LANES', name: 'Drive Thru Lanes', type: 'number'}
]
})
};
fetch('https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/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}/location-attributes/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([
'attributes' => [
[
'externalId' => 'REGION',
'name' => 'Region',
'description' => 'Operational region',
'type' => 'single_select',
'options' => [
[
'label' => 'Southwest',
'color' => '#7C5CFC'
],
[
'label' => 'Midwest',
'color' => '#22B8CF'
]
]
],
[
'externalId' => 'DRIVE_THRU_LANES',
'name' => 'Drive Thru Lanes',
'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}/location-attributes/bulk-upsert"
payload := strings.NewReader("{\n \"attributes\": [\n {\n \"externalId\": \"REGION\",\n \"name\": \"Region\",\n \"description\": \"Operational region\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Southwest\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Midwest\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"DRIVE_THRU_LANES\",\n \"name\": \"Drive Thru Lanes\",\n \"type\": \"number\"\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}/location-attributes/bulk-upsert")
.header("x-client-key", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attributes\": [\n {\n \"externalId\": \"REGION\",\n \"name\": \"Region\",\n \"description\": \"Operational region\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Southwest\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Midwest\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"DRIVE_THRU_LANES\",\n \"name\": \"Drive Thru Lanes\",\n \"type\": \"number\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.xenia.team/api/v1/mgt/enterprise/workspaces/{workspaceId}/location-attributes/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 \"attributes\": [\n {\n \"externalId\": \"REGION\",\n \"name\": \"Region\",\n \"description\": \"Operational region\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"label\": \"Southwest\",\n \"color\": \"#7C5CFC\"\n },\n {\n \"label\": \"Midwest\",\n \"color\": \"#22B8CF\"\n }\n ]\n },\n {\n \"externalId\": \"DRIVE_THRU_LANES\",\n \"name\": \"Drive Thru Lanes\",\n \"type\": \"number\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"externalId": "REGION",
"id": "1f6c9e0a-2b7d-4d5e-9a11-8c3f5b6d7e88",
"name": "Region",
"created": true
},
{
"externalId": "DRIVE_THRU_LANES",
"id": "2a7d0f1b-3c8e-4e6f-9b22-9d4a6c7e8f99",
"name": "Drive Thru Lanes",
"created": false
}
],
"extra_meta": {
"message": "Attributes upserted"
}
}Path Parameters
UUID of the workspace. Must be the workspace your API key is bound to.
Body
application/json
Attribute definitions to upsert.
Required array length:
1 - 500 elementsShow child attributes
Show child attributes
Response
One result row per input row, in request order. created distinguishes an insert from an update.
⌘I