Loading ...

REST API: Add Tags | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Tags » REST API: Add Tags
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 30

REST API: Add Tags

0 
 /5
0 (0votes)
Open API Guide
POST/api/tags

Allow user to add tags in content

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
TagsStringYESQueryComma-separated list of tag names to apply to the content (e.g., "announcement,important,hr").
SpaceIDIntegerYESQueryUnique ID of the space
EntityIDIntegerYESQueryUnique ID of the Content
EntityTypeIntegerYESQueryThe entity type of the content. See REST API: System Entity Types. 

Optional Parameters

ParameterTypeRequiredLocationDescription
MergeWithExistingBooleanNOQueryWhether to add the tags to the content's existing tags (true) or as replacements for existing tags (false). True by default.
IsPromotedBooleanNOQueryWhether the tags are added as promoted tags. Default: false.
ContentTypeIDIntegerNOQueryContent type ID of the item when it is a custom content type. Default: none.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/tags?tags=mytag,research&spaceid=0&entityid=137&entitytype=3

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

{
  "Message": "The requested resource does not support http method 'POST'."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (tags, spaceID, entityType, entityID)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none: the message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter; the message is not about the resource.

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