locations

Create a location category

Creates a location category for the studio. The name must be unique across location categories, tag categories and asset custom fields.

POST

/v1/location-categories

curl --request POST \
  --url https://api.beamdynamics.io/v1/location-categories \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "yellow",
  "description": "<string>",
  "name": "<string>"
}
'

{
  "color": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "locationCount": 123,
  "name": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Body

colorenum<string>required

Category color name. One of: yellow, orange, red, pink, violet, blue, teal, green, black, gray, default. The response returns the color as a hex code

Available options: yellow, orange, red, pink, violet, blue, teal, green, black, gray, default

descriptionstring | null

Optional location category description. Send null or omit for none

namestringrequired

Location category name. Must be unique across the studio

Minimum string length: 1

Response

The created location category

colorstringrequired

descriptionstring | nullrequired

idstringrequired

locationCountnumberrequired

namestringrequired

Still need help? Ask the team