locations

Create a location

Creates a location in a location category of the studio, optionally nested under a parent location of the same category. Locations can be nested up to 6 levels.

POST

/v1/locations

Create a location

curl --request POST \
  --url https://api.beamdynamics.io/v1/locations \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "color": "<string>",
  "description": "<string>",
  "externalId": "<string>",
  "icon": "<string>",
  "locationCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "address": "<string>",
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "externalId": "<string>",
  "icon": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locationCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "nestedLevel": 123,
  "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

beam-api-keystringheaderrequired

Body

addressstring | null

Optional location address. Send null or omit for none

colorstring

Optional hex color, for example #1a2b3c. The location category color takes precedence when it has one

Pattern: ^#([0-9a-f]{3}){1,2}$/i

descriptionstring | null

Optional location description. Send null or omit for none

externalIdstring

Optional identifier of the location in an external system

iconstringrequired

Icon identifier for the location

Minimum string length: 1

locationCategoryIdstringrequired

Id of a location category belonging to the studio

namestringrequired

Location name. Must be unique under the same parent within the location category

Minimum string length: 1

parentIdstring | null

Optional id of the parent location. The parent must belong to the same studio and location category. Send null or omit for a top level location

Response

The created location

addressstring | nullrequired

colorstringrequired

createdAtstringrequired

descriptionstring | nullrequired

externalIdstring | nullrequired

iconstringrequired

idstringrequired

locationCategoryIdstringrequired

namestringrequired

nestedLevelnumberrequired

parentIdstring | nullrequired

updatedAtstringrequired

Still need help? Ask the team