REST API: Add Tags

Anonymous User

Published: 11/21/2019

Grace Kamau

Updated: 8/31/2020

0 (0votes)

Add Tags

Allow user to add tags in content. Valid for Communifire version 6.0 and above.

HTTP Method

POST

Response Format

JSON

Requires Authentication?

YES

Product Version

6.0 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
TagsCSV	&tagscsv=x - Used in the request URL	CSV of tags.
SpaceID	&spaceid=x - Used in the request URL	Unique ID of the space.
EntityID	&entityid=x - Used in the request URL (see below)	Unique ID of the Content.
EntityType	&entitytype=x - Used in the request URL (see below)	The entity type of the content. REST API: System Entity Types

Optional Parameters	How to use	Description
MergeWithExisting	&mergeWithExisting=x - Used in the request URL (see below)	Whether to add the tags to the content's existing tags (true) or as replacements for existing tags (false). True by default.

Example URL: https://your-community.com/api/tags?tags=mytag&spaceid=0&entityid=137&entitytype=3

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

Please Note Your content type that you pass in the header of your request should be 'application/json'.