REST Tag

Create, change or delete tags

List tags

Lists all tags. The results can be filtered.

/rest/tags

Parameters

Field Type Description
with String Includes the specified tag information in the results. The following parameters are available:
  • availabilities = The tag availabilities
  • names = The tag names
  • relationship = The tag relationships
More than one parameter should be separated by commas.
tagName String Filter restricts the list of results to tags with the specified tag name. The tag name must be specified.
tagAvailability String Filter restricts the list of results to tags with the specified availability type. The availability type must be specified.
tagLang String Filter restricts the list of results to tags which have names in the specified language. The language must be specified.
color String Filter restricts the list of results to tags with the specified color. The color must be specified.

Success 200

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a tag by ID

Gets a tag by ID. The ID of the tag must be specified.

/rest/tags/{id}

Success 200

Field Type Description
id Int The tag ID
tagName String The name of the tag
color String The color for the tag
updatedAt String The updated at timestamp of the tag.
createdAt String The created at timestamp of the tag.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a tag

/rest/tags

Request

Field Type Description
tagName String The name of the tag required required
color String The color for the tag optional
availabilities \TagAvailability[] The availabilities of the tag. optional array
 tagType String The type of the tag. The following types are available.
  • blog
  • category
  • content_page
  • variation
  • ticket
  • board
  • order
required allowed values are category, ticket, variation, board, contact, order
names \TagName[] The names of the tag. required array
 tagName String The name of the tag. required
 tagLang String The lang of the tag name. required allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn
null

Success 200

Field Type Description
id Int The tag ID
tagName String The name of the tag
color String The color for the tag
updatedAt String The updated at timestamp of the tag.
createdAt String The created at timestamp of the tag.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a tag

Updates a tag. The ID of the tag must be specified.

/rest/tags/{id}

Request

Field Type Description
tagName String The name of the tag required required
color String The color for the tag optional
availabilities \TagAvailability[] The availabilities of the tag. optional array
 tagType String The type of the tag. The following types are available.
  • blog
  • category
  • content_page
  • variation
  • ticket
  • board
  • order
required allowed values are category, ticket, variation, board, contact, order
names \TagName[] The names of the tag. required array
 tagName String The name of the tag. required
 tagLang String The lang of the tag name. required allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn
null

Success 200

Field Type Description
id Int The tag ID
tagName String The name of the tag
color String The color for the tag
updatedAt String The updated at timestamp of the tag.
createdAt String The created at timestamp of the tag.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete a tag

Deletes a tag. The ID of the tag must be specified.

/rest/tags/{id}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create up to 50 tags

Creates up to 50 tags. The IDs of the tags must be specified.

/rest/tags/bulk

Request

Field Type Description
tagName String The name of the tag required required
color String The color for the tag optional
availabilities \TagAvailability[] The availabilities of the tag. optional array
 tagType String The type of the tag. The following types are available.
  • blog
  • category
  • content_page
  • variation
  • ticket
  • board
  • order
required allowed values are category, ticket, variation, board, contact, order
names \TagName[] The names of the tag. required array
 tagName String The name of the tag. required
 tagLang String The lang of the tag name. required allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn
null

Success 200

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update up to 50 tags.

Updates up to 50 tags. The IDs of the tags must be specified.

/rest/tags/bulk

Request

Field Type Description
tagName String The name of the tag required required
color String The color for the tag optional
availabilities \TagAvailability[] The availabilities of the tag. optional array
 tagType String The type of the tag. The following types are available.
  • blog
  • category
  • content_page
  • variation
  • ticket
  • board
  • order
required allowed values are category, ticket, variation, board, contact, order
names \TagName[] The names of the tag. required array
 tagName String The name of the tag. required
 tagLang String The lang of the tag name. required allowed values are de, en, bg, fr, it, es, tr, nl, pl, pt, nn, ro, da, se, cz, ru, sk, cn, vn
null

Success 200

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!