Skip to main content
POST
/
tags
Create a new tag
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/tags \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "value": "<string>",
  "config": {
    "filtering": [
      "achievement"
    ],
    "display": [
      "achievement"
    ],
    "iconifyIcon": "<string>"
  }
}'
{
  "id": "<string>",
  "organisationId": "<string>",
  "value": "<string>",
  "config": {
    "filtering": [
      "achievement"
    ],
    "display": [
      "achievement"
    ],
    "iconifyIcon": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>"
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

The language for the initial content of the tag. If not provided, the default language for the organisation will be used.

Body

application/json

The input required to create a tag

value
string
required

The value of the tag

Minimum length: 1
config
object

The configuration of a tag

Response

Successful response

A tag

id
string
required

The id of the tag

organisationId
string
required

The id of the organisation the tag belongs to

value
string
required

The value of the tag

Minimum length: 1
config
object
required

The configuration of a tag

createdAt
string
required

The date the tag was created

updatedAt
string
required

The date the tag was last updated

createdBy
string
required

The id of the user who created the tag

updatedBy
string
required

The id of the user who last updated the tag

I