Tags
Manage resource tags and tag assignments. The examples use A2A code mode. MCP exposes the same code mode through itsexecute tool.
Functions
tags.add
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | tag.manage | Auth required | yes |
| Execution mode | sync | Capability | tag.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/tags |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
tag_name | str | yes | Tag display name |
color_hex | str | no | Tag color as a hex code |
description | str | null | no | Optional tag description |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
color_hex | str | yes | Tag color as a hex code |
id | str | yes | Tag UUID |
name | str | yes | Tag display name |
created_at | str | null | no | Tag creation timestamp |
description | str | null | no | Optional tag description |
updated_at | str | null | no | Tag last update timestamp |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
tags.delete
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | tag.manage | Auth required | yes |
| Execution mode | sync | Capability | tag.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/tags/{tag_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
tag_id | str | yes | Tag UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
tags.domains.assign
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | tag.manage | Auth required | yes |
| Execution mode | sync | Capability | tag.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/assign |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
tag_id | str | yes | Tag UUID from the route path |
domain_ids | [str] | yes | Domain UUIDs or domain names to assign or unassign. |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
domain_ids | [str] | yes | Domain UUIDs affected by the assignment |
tag_id | str | yes | Tag UUID |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
tags.domains.unassign
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | tag.manage | Auth required | yes |
| Execution mode | sync | Capability | tag.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/unassign |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
tag_id | str | yes | Tag UUID from the route path |
domain_ids | [str] | yes | Domain UUIDs or domain names to assign or unassign. |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
tags.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | tag.view | Auth required | yes |
| Execution mode | sync | Capability | tag.view |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/tags |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
page | int | no | One-based tag page number |
page_size | int | no | Maximum tags per page |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
items | [{"color_hex": str, "id": str, "name": str, "created_at"?: str | null, "description"?: str | null, "updated_at"?: str | null}] | yes | Tags on this page |
page | int | yes | Current one-based page number |
page_size | int | yes | Maximum items per page |
total | int | yes | Total matching tags |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response:
tags.update
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | tag.manage | Auth required | yes |
| Execution mode | sync | Capability | tag.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | PATCH /v1/public/accounts/{account_id}/tags/{tag_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID from the route path |
tag_id | str | yes | Tag UUID from the route path |
color_hex | str | null | no | Tag color as a hex code |
description | str | null | no | Optional tag description |
tag_name | str | null | no | Tag display name |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
color_hex | str | yes | Tag color as a hex code |
id | str | yes | Tag UUID |
name | str | yes | Tag display name |
created_at | str | null | no | Tag creation timestamp |
description | str | null | no | Optional tag description |
updated_at | str | null | no | Tag last update timestamp |
A2A example
A2A example
Request:Response:
MCP example
MCP example
Request:Response: