Tags¶

Tags are used to organize and group mytokens, notifications, and calendars. A user can create custom tags and assign them to various resources. Tags can optionally include a color for visual identification.

Tag Types¶

Tag¶

A Tag is a simple string representing the name of a tag. Tag names are user-defined and should be descriptive.

Example

"CI-Tokens"

CreateMytokenTag¶

When creating a mytoken, tags can be assigned using the CreateMytokenTag type. This allows specifying whether the tag should also apply to future children of the mytoken.

Field	Type	Necessity	Description
`tag`	string	REQUIRED	The tag name to assign
`include_children`	boolean	OPTIONAL	If `true`, the tag will also be applied to current and future children of this mytoken. Default: `false`

Example

{
    "tag": "production",
    "include_children": true
}

TagInfo¶

A TagInfo object provides information about a tag, including its name and optional color.

Field	Type	Necessity	Description
`tag`	string	REQUIRED	The tag name
`color`	string	OPTIONAL	A color associated with the tag (e.g., hex color code)

Example

{
    "tag": "production",
    "color": "#ff5733"
}

MTTagInfo¶

An MTTagInfo object extends TagInfo with information about whether the tag applies to children of a mytoken.

Field	Type	Necessity	Description
`tag`	string	REQUIRED	The tag name
`color`	string	OPTIONAL	A color associated with the tag
`include_children`	boolean	REQUIRED	Indicates if the tag is inherited by children of this mytoken

Example

{
    "tag": "development",
    "color": "#33ff57",
    "include_children": false
}

Tag Management¶

Tags can be managed through the Tags Settings Endpoint. Users can:

List all their tags
Create new tags
Update tag properties (name, color)
Delete tags

Assigning Tags¶

Tags can be assigned to:

Mytokens: When creating a mytoken, use the tags parameter. Existing mytokens can have tags added or removed via the mytoken tags endpoint.
Notifications: Tags can be specified when creating notifications or updated later.
Calendars: Tags can be associated with calendars for organization.

Tag Capabilities¶

The following capabilities are related to tag management:

Capability	Description
`settings:tags`	Read/write access to user's tags
`read@settings:tags`	Read-only access to user's tags
`tokeninfo:tags`	Manage tags for this mytoken
`manage_mytokens:tags`	Manage tags for any mytoken

For more details on capabilities, see Capabilities.

Last update: March 30, 2026 14:00:08