Create a tag

Creates a tag in a tag category of the studio. The name must be unique within the category, case-insensitive.

POST

/v1/tags

Create a tag

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

{
  "createdAt": "<string>",
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "tagCategory": {
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "tagCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Body

descriptionstring | null

Optional tag description, up to 2000 characters. An empty string is stored as null.

Maximum string length: 2000

namestringrequired

Tag name, 1-255 characters. Must be unique within the tag category (case-insensitive).

Required string length: 1 - 255

tagCategoryIdstringrequired

Id of the tag category of the studio the tag is created in.

Response

The created tag

createdAtstringrequired

descriptionstring | nullrequired

idstringrequired

namestringrequired

tagCategoryobject | nullrequired

Show child attributes

tagCategoryIdstring | nullrequired

updatedAtstringrequired

Still need help? Ask the team