Your browser don't permit web-fonts to be installed. Our websites use web-fonts based icons. For a better experience please allow your browser to use web-fonts.
We are hiring!
Deutsch | English | Español

2.20. Tag

The tag object provides methods to manage (create, update, list etc.) your tags.

2.20.1. tag.create

Creates a new tag or returns the ID, if it already exists

2.20.1.1. Input

Table 2.217. Parameters

ParameterDescriptionTypeRequiredDefault
nameName of the new tag token255 true 

2.20.1.2. Output

Table 2.218. Parameters

ParameterDescriptionTypeOptional
idID of the created tag int  
nameName of your tag after removing invalid characters token255  

2.20.2. tag.delete

Untags all objects and deletes a tag

2.20.2.1. Input

Table 2.219. Parameters

ParameterDescriptionTypeRequiredDefault
idID of the tag to delete int true 

2.20.2.2. Output

No additional return parameters

2.20.3. tag.info

Get tag info.

2.20.3.1. Input

Table 2.220. Parameters

ParameterDescriptionTypeRequiredDefault
idID of the tag int true 

2.20.3.2. Output

Table 2.221. Parameters

ParameterDescriptionTypeOptional
idID of the tag int  
nameName of the tag token255  

2.20.4. tag.list

List all existing tags by searching via tag IDs or tagged domains.

2.20.4.1. Input

Table 2.222. Parameters

ParameterDescriptionTypeRequiredDefault
domainFilter by single or multiple domain names array_domain false 
idFilter by single or multiple tag IDs array_int false 

2.20.4.2. Output

Table 2.223. Parameters

ParameterDescriptionTypeOptional
countTotal number of tags int  
tag   
... idID of the tag int  
... nameName of the tag token255  
... count  Yes
... ... domainNumber of domains using this tag, only shown when searched with tag ID int  

2.20.5. tag.update

Update the name of an existing tag or add/remove said tag to domains. Updating tag name has priority and ignores add/rem.

2.20.5.1. Input

Table 2.224. Parameters

ParameterDescriptionTypeRequiredDefault
idID of the tag int true 
nameNew tag name token255 false 
addTag to object, can be a list of IDs tagUpdateAdd false 
remUntag from object, can be a list of IDs tagUpdateRem false 

2.20.5.2. Output

Table 2.225. Parameters

ParameterDescriptionTypeOptional
idID of the tag, only present when name was updated int Yes
nameName of the tag, only present when name was updated token255 Yes