Validate a tag type | Unleash Documentation

Validates whether if the body of the request is a valid tag and whether the a tag type with that name already exists or not. If a tag type with the same name exists, this operation will return a 409 status code.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Request

tagTypeSchema

namestringRequired

The name of the tag type.

descriptionstringOptional

The description of the tag type.

iconstring or nullOptional

The icon of the tag type.

colorstring or nullOptionalformat: "^#[0-9A-Fa-f]{6}$"

The hexadecimal color code for the tag type.

Response

validateTagTypeSchema

validboolean

Whether or not the tag type is valid.

tagTypeobject

A tag type.

1	import requests
2
3	url = "https://app.unleash-instance.example.com/api/admin/tag-types/validate"
4
5	payload = { "name": "color" }
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"valid": true,
3	"tagType": {
4	"name": "color",
5	"description": "A tag type for describing the color of a tag.",
6	"icon": "not-really-used",
7	"color": "#FFFFFF"
8	}
9	}

Authentication

Request

Response

Errors