Loading ...

REST API: Update Tags in the Tag Group | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Tags » REST API: Update Tags in the Tag Group
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 22

REST API: Update Tags in the Tag Group

0 
 /5
0 (0votes)
Open API Guide
PATCH/api/taggroups/{GroupID}/tags

Add, remove, or replace the tags in a tag group. Requires the Manage Metadata permission. ResponseData is the tag group with its tags after the change. Error responses carry the same envelope with IsError true and the reason in ResponseMessage.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
GroupIDIntegerYESPathUnique identifier of the tag group you want to modify
Tags JSONStringYESBodyThis is JSON that specifies how the tags in the group are updated. It should follow the format shown in the sample below, and the supported values are outlined below.

Optional Parameters

ParameterTypeRequiredLocationDescription
addTagsArrayNOBodyArray of tag names to add to the tag group
removeTagsArrayNOBodyArray of tag names to remove from the tag group
replaceTagsArrayNOBodyArray of tag names that overwrites all tags in the tag group. When passed, all existing tags are removed and replaced with this list. Note: This parameter is applied independently and cannot be combined with addTags or removeTags.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/taggroups/55/tags

Request Body

{
  "addTags": [
    "hr policies",
    "benefits"
  ],
  "removeTags": [
    "legacy"
  ]
}

Success Response

{
  "IsError": false,
  "ResponseData": {
    "TagGroupID": 36,
    "TagGroupName": "API Validate matrix group 4752",
    "Tags": [
      {
        "TagID": 724,
        "TagGroupID": 36,
        "TagName": "benefits",
        "EntityID": 0,
        "EntityType": 0,
        "SpaceID": 0,
        "TagWeight": 0,
        "TagCount": 0,
        "IsPromoted": false,
        "TenantID": 0
      }
    ],
    "TenantID": 0
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestGroupID is 0 or less (TagGroupID required), the body is missing (Invalid data entered.), no tag group has that ID (Content Not Found), or replaceTags was combined with addTags or removeTags (Invalid data entered.).Send a positive GroupID and either replaceTags alone or addTags and removeTags.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller lacks the Manage Metadata permission (Permission denied).Call with a token that can manage metadata.
200 with IsErrorThe tags could not be updated.Retry later.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages