APIDocumentation

Deutsch | English | Español

Your country is:

2.17. Tag
Prev	Chapter 2. Methods	Next

2.17. Tag

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

2.17.1. tag.create

Creates a new tag.

2.17.1.1. Input

Table 2.188. Parameters

Parameter	Description	Type	Required	Default
name	Name of tag	token255	true

2.17.1.2. Output

Table 2.189. Parameters

Parameter	Description	Type	Optional
id	Id of the created tag	int

2.17.2. tag.delete

Delete a tag.

2.17.2.1. Input

Table 2.190. Parameters

Parameter	Description	Type	Required	Default
id	Id of the tag	int	true

2.17.2.2. Output

No additional return parameters

2.17.3. tag.info

Get tag info.

2.17.3.1. Input

Table 2.191. Parameters

Parameter	Description	Type	Required	Default
id	Id of the tag	int	true

2.17.3.2. Output

Table 2.192. Parameters

Parameter	Description	Type	Optional
id	Id of the tag	int
name	Name of tag	token255

2.17.4. tag.list

List of all exsiting tags.

2.17.4.1. Input

Table 2.193. Parameters

Parameter	Description	Type	Required	Default
domain	Filter by domain name	array_domain	false
id	Filter by tag ids	array_int	false

2.17.4.2. Output

Table 2.194. Parameters

Parameter	Description	Type
count	Total number of tags	int
tag
... id	Id of the tag	int
... name	Name of the tag	token255

2.17.5. tag.update

Updates an existing tag.

2.17.5.1. Input

Table 2.195. Parameters

Parameter	Description	Type	Required
id	Id of the tag	int	true
name	New tag name	token255	false
add	Set tag to object	tagUpdateAdd	false
rem	Set tag to object	tagUpdateRem	false

2.17.5.2. Output