Create tag - AWorld API

Creates a new tag with a system-generated ID

curl --location --request POST 'https://api.eu-west-1.aworld.cloud/dashboard/v1/tags' \ --header 'Content-Type: application/json' \ --data-raw '{ "namespace": "string", "variant": "string", "defaultLang": "string", "translations": [ { "lang": "string", "label": "string", "description": "string" } ] }'

{ "tagId": "string", "namespace": "string", "variant": "string", "origin": "CATALOG", "tagCatalogId": "string", "syncWithCatalog": true, "defaultLang": "string", "langs": [ "string" ], "accountId": "string", "workspaceId": "string", "sourceRegion": "string", "stage": "DRAFT", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Data required to create a new tag

namespace

string

required

Namespace that groups related tags together

variant

string

required

Variant identifier within the namespace

defaultLang

string

required

The default language code for the tag content

translations

array[object (TagTranslation) {3}]

required

List of translations for the tag content

>= 1 items<= 10 items

lang

string

required

Language code for this translation

label

string

required

Translated label for the tag

description

string

optional

Translated description for the tag

Examples

Responses

🟢200OK

application/json

Tag created successfully

Body

Tag entity used for categorizing and filtering content

tagId

string

required

Unique identifier for the tag

namespace

string

required

Namespace that groups related tags together

variant

string

required

Variant identifier within the namespace

origin

enum<string>

required

Whether the tag comes from a central catalog or is custom-created

Allowed values:

CATALOGCUSTOM

tagCatalogId

string

optional

ID reference to the original tag in the catalog if applicable

syncWithCatalog

boolean

optional

Whether the tag should be synced with catalog updates

defaultLang

string

required

The default language code for the tag content

langs

array[string]

required

List of language codes available for this tag

accountId

string

optional

The account ID that owns this tag

workspaceId

string

optional

The workspace ID that contains this tag

sourceRegion

string

optional

AWS region where the tag was created

stage

enum<string>

optional

Current publication stage of the tag

Allowed values:

DRAFTPUBLISHED

createdAt

string <date-time>

required

Timestamp when the tag was created

updatedAt

string <date-time>

required

Timestamp when the tag was last updated

🟠400Bad Request

🟠401Unauthorized