v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB

Attributes

Add tag(s) to attribute(s)

Add one or multiple tags to one or multiple attributes

post/attributes/addTag/{attributeId}/{tagId}/local:{local}

Path parameters

attributeIdstring required

Attribute ID or 'selected' to add tags to multiple attributes

tagIdstring required

Tag ID, tag name or tag collection ID (format collection_N)

local0 | 1 required

Whether to add tag as local tag (1) or global tag (0). Leave the other path params empty if you want to add local tags using the json request body params

Request body

attributestring

Attribute ID when path param id is not set

attribute_idsstring

JSON encoded array of attribute IDs when id is 'selected'

tagstring

Tag ID/name or tag collection ID (format collection_N) when path param 'tagId' is not specified. This can also be a JSON encoded array of IDs/names and tag collection IDs to add multiple tags at once. Required if path param 'tagId' is not set

Example request

{
  "attribute": "12",
  "attribute_ids": "[\"1\",\"2\"]",
  "tag": "[\"tag\",\"1\",\"collection_1\"]"
}

Response

Add attribute tag response

savedboolean

true if the tag was successfully added, false if it failed

successstring nullable

Present if the tag was successfully added

check_publishboolean nullable

errorsstring nullable

Example response

{
  "success": "Tag added.",
  "errors": "Tag could not be added."
}