APIDocumentation

Deutsch | English | Español

Moneda:

CHF

Su país es:

Seleccione su país

2.20. Tag
Prev	Chapter 2. Methods	Next

2.20. Tag

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

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

Table 2.220. Parameters

Parameter	Description	Type	Required	Default
name	Name of the new tag	token255	true

Table 2.221. Parameters

Parameter	Description	Type	Optional
id	ID of the created tag	int
name	Name of your tag after removing invalid characters	token255

Untags all objects and deletes a tag

Table 2.222. Parameters

Parameter	Description	Type	Required	Default
id	ID of the tag to delete	int	true

No additional return parameters

Get tag info.

Table 2.223. Parameters

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

Table 2.224. Parameters

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

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

Table 2.225. Parameters

Parameter	Description	Type	Required	Default
domain	Filter by single or multiple domain names	array_domain	false
id	Filter by single or multiple tag IDs	array_int	false

Table 2.226. Parameters

Parameter	Description	Type	Optional
count	Total number of tags	int
tag
... id	ID of the tag	int
... name	Name of the tag	token255
... count			Yes
... ... domain	Number of domains using this tag, only shown when searched with tag ID	int

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

Table 2.227. Parameters

Parameter	Description	Type	Required
id	ID of the tag	int	true
name	New tag name	token255	false
add	Tag to object, can be a list of IDs	tagUpdateAdd	false
rem	Untag from object, can be a list of IDs	tagUpdateRem	false