Create a tag category

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

POST

/v1/tag-categories

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

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

Body

colorenum<string>required

Category color name. One of: blue, green, orange, pink, red, teal, violet, yellow

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

descriptionstring | null

Optional tag category description. Send null or omit for none

namestringrequired

Tag category name, up to 255 characters. Must be unique across tag categories, location categories and asset custom fields

Required string length: 1 - 255

Response

The created tag category

colorenum<string>required

Category color as a hex string. One of: #E7E4F9, #DCF2EA, #FFEFD2, #D3F5F7, #F8E3DA, #FBDDF3, #F9DADA, #E6EDFF, #EDEFF4. Requests take a color name instead: blue, green, orange, pink, red, teal, violet, yellow

Available options: #E7E4F9, #DCF2EA, #FFEFD2, #D3F5F7, #F8E3DA, #FBDDF3, #F9DADA, #E6EDFF, #EDEFF4

descriptionstring | nullrequired

idstringrequired

namestringrequired

Still need help? Ask the team

Authorizations

Body

Response