Loading ...

REST API: Update Tag Group | Axero Documentation

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

REST API: Update Tag Group

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

Rename a tag group. Requires the Manage Metadata permission. ResponseData is the tag group with its new name. 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 update
TagGroupNameStringYESBodyNew name of the tag group, sent as a JSON object with a TagGroupName property.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/taggroups/52

Request Body

{
  "TagGroupName": "HR Policies"
}

Success Response

{
  "IsError": false,
  "ResponseData": {
    "TagGroupID": 35,
    "TagGroupName": "HR Policies e66c",
    "TenantID": 1
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "TagGroupName required"
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestGroupID is 0 or less (TagGroupID required), TagGroupName is missing or blank (TagGroupName required), or GroupID in the path is not an integer.Send a positive GroupID and a non-blank TagGroupName.
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 IsErrorNo tag group has that ID or the rename failed (Processing Failed).Verify the GroupID with Get Tag Groups.
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