> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Tags

> Resourcetags en tagtoewijzingen beheren.

# Tags

Resourcetags en tagtoewijzingen beheren.

<script src="/locale-bridge.js" />

De voorbeelden gebruiken de A2A-codemodus. MCP biedt dezelfde codemodus via het hulpmiddel `execute`.

## Functies

### `tags.add`

```text theme={null}
tags.add(account_id: str, tag_name: str, color_hex?: str, description?: str | null) -> Tag
```

Tags: `tags.add`.

| Eigenschap          | Waarde                                       | Eigenschap            | Waarde       |
| ------------------- | -------------------------------------------- | --------------------- | ------------ |
| Vereiste machtiging | `tag.manage`                                 | Authenticatie vereist | `ja`         |
| Uitvoermodus        | `sync`                                       | Mogelijkheid          | `tag.manage` |
| Resourcetype        | `account`                                    | Resource-ID-veld      | `account_id` |
| Openbare API-route  | `POST /v1/public/accounts/{account_id}/tags` |                       |              |

<AccordionGroup>
  <Accordion title="Argumenten">
    | Naam          | Type          | Vereist |
    | ------------- | ------------- | ------- |
    | `account_id`  | `str`         | ja      |
    | `tag_name`    | `str`         | ja      |
    | `color_hex`   | `str`         | nee     |
    | `description` | `str \| null` | nee     |
  </Accordion>

  <Accordion title="Retourneert">
    | Veld          | Type          | Vereist |
    | ------------- | ------------- | ------- |
    | `color_hex`   | `str`         | ja      |
    | `id`          | `str`         | ja      |
    | `name`        | `str`         | ja      |
    | `created_at`  | `str \| null` | nee     |
    | `description` | `str \| null` | nee     |
    | `updated_at`  | `str \| null` | nee     |
  </Accordion>

  <Accordion title="A2A-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "tags.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_name=\"<string>\", color_hex=\"<string>\", description=\"<string>\")"
    }
    ```

    Respons:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "tags.add",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "tags.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_name=\"<string>\", color_hex=\"<string>\", description=\"<string>\")"
        }
      }
    }
    ```

    Respons:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.add\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `tags.delete`

```text theme={null}
tags.delete(account_id: str, tag_id: str) -> {}
```

Tags: `tags.delete`.

| Eigenschap          | Waarde                                                  | Eigenschap            | Waarde       |
| ------------------- | ------------------------------------------------------- | --------------------- | ------------ |
| Vereiste machtiging | `tag.manage`                                            | Authenticatie vereist | `ja`         |
| Uitvoermodus        | `sync`                                                  | Mogelijkheid          | `tag.manage` |
| Resourcetype        | `account`                                               | Resource-ID-veld      | `account_id` |
| Openbare API-route  | `DELETE /v1/public/accounts/{account_id}/tags/{tag_id}` |                       |              |

<AccordionGroup>
  <Accordion title="Argumenten">
    | Naam         | Type  | Vereist |
    | ------------ | ----- | ------- |
    | `account_id` | `str` | ja      |
    | `tag_id`     | `str` | ja      |
  </Accordion>

  <Accordion title="Retourneert">
    | Veld     | Type | Vereist |
    | -------- | ---- | ------- |
    | `result` | `{}` | ja      |
  </Accordion>

  <Accordion title="A2A-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "tags.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
    ```

    Respons:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": {}
      },
      "responses": [
        {
          "index": 0,
          "function": "tags.delete",
          "status": "completed",
          "result": {}
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "tags.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
        }
      }
    }
    ```

    Respons:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `tags.domains.assign`

```text theme={null}
tags.domains.assign(account_id: str, tag_id: str, domain_ids: [str]) -> Tag
```

Tags: `tags.domains.assign`.

| Eigenschap          | Waarde                                                               | Eigenschap            | Waarde       |
| ------------------- | -------------------------------------------------------------------- | --------------------- | ------------ |
| Vereiste machtiging | `tag.manage`                                                         | Authenticatie vereist | `ja`         |
| Uitvoermodus        | `sync`                                                               | Mogelijkheid          | `tag.manage` |
| Resourcetype        | `account`                                                            | Resource-ID-veld      | `account_id` |
| Openbare API-route  | `POST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/assign` |                       |              |

<AccordionGroup>
  <Accordion title="Argumenten">
    | Naam         | Type    | Vereist |
    | ------------ | ------- | ------- |
    | `account_id` | `str`   | ja      |
    | `tag_id`     | `str`   | ja      |
    | `domain_ids` | `[str]` | ja      |
  </Accordion>

  <Accordion title="Retourneert">
    | Veld         | Type    | Vereist |
    | ------------ | ------- | ------- |
    | `domain_ids` | `[str]` | ja      |
    | `tag_id`     | `str`   | ja      |
  </Accordion>

  <Accordion title="A2A-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "tags.domains.assign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
    }
    ```

    Respons:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": {
          "domain_ids": [
            "<string>"
          ],
          "tag_id": "<string>"
        }
      },
      "responses": [
        {
          "index": 0,
          "function": "tags.domains.assign",
          "status": "completed",
          "result": {
            "domain_ids": [
              "<string>"
            ],
            "tag_id": "<string>"
          }
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "tags.domains.assign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
        }
      }
    }
    ```

    Respons:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"domain_ids\": [\n        \"<string>\"\n      ],\n      \"tag_id\": \"<string>\"\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.domains.assign\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"domain_ids\": [\n          \"<string>\"\n        ],\n        \"tag_id\": \"<string>\"\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `tags.domains.unassign`

```text theme={null}
tags.domains.unassign(account_id: str, tag_id: str, domain_ids: [str]) -> {}
```

Tags: `tags.domains.unassign`.

| Eigenschap          | Waarde                                                                 | Eigenschap            | Waarde       |
| ------------------- | ---------------------------------------------------------------------- | --------------------- | ------------ |
| Vereiste machtiging | `tag.manage`                                                           | Authenticatie vereist | `ja`         |
| Uitvoermodus        | `sync`                                                                 | Mogelijkheid          | `tag.manage` |
| Resourcetype        | `account`                                                              | Resource-ID-veld      | `account_id` |
| Openbare API-route  | `POST /v1/public/accounts/{account_id}/tags/{tag_id}/domains/unassign` |                       |              |

<AccordionGroup>
  <Accordion title="Argumenten">
    | Naam         | Type    | Vereist |
    | ------------ | ------- | ------- |
    | `account_id` | `str`   | ja      |
    | `tag_id`     | `str`   | ja      |
    | `domain_ids` | `[str]` | ja      |
  </Accordion>

  <Accordion title="Retourneert">
    | Veld     | Type | Vereist |
    | -------- | ---- | ------- |
    | `result` | `{}` | ja      |
  </Accordion>

  <Accordion title="A2A-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "tags.domains.unassign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
    }
    ```

    Respons:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": {}
      },
      "responses": [
        {
          "index": 0,
          "function": "tags.domains.unassign",
          "status": "completed",
          "result": {}
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "tags.domains.unassign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
        }
      }
    }
    ```

    Respons:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.domains.unassign\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `tags.list`

```text theme={null}
tags.list(account_id: str, page?: int, page_size?: int) -> Page[Tag]
```

Tags: `tags.list`.

| Eigenschap          | Waarde                                      | Eigenschap            | Waarde       |
| ------------------- | ------------------------------------------- | --------------------- | ------------ |
| Vereiste machtiging | `tag.view`                                  | Authenticatie vereist | `ja`         |
| Uitvoermodus        | `sync`                                      | Mogelijkheid          | `tag.view`   |
| Resourcetype        | `account`                                   | Resource-ID-veld      | `account_id` |
| Openbare API-route  | `GET /v1/public/accounts/{account_id}/tags` |                       |              |

<AccordionGroup>
  <Accordion title="Argumenten">
    | Naam         | Type  | Vereist |
    | ------------ | ----- | ------- |
    | `account_id` | `str` | ja      |
    | `page`       | `int` | nee     |
    | `page_size`  | `int` | nee     |
  </Accordion>

  <Accordion title="Retourneert">
    | Veld        | Type                                                                                                                                | Vereist |
    | ----------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------- |
    | `items`     | `[{"color_hex": str, "id": str, "name": str, "created_at"?: str \| null, "description"?: str \| null, "updated_at"?: str \| null}]` | ja      |
    | `page`      | `int`                                                                                                                               | ja      |
    | `page_size` | `int`                                                                                                                               | ja      |
    | `total`     | `int`                                                                                                                               | ja      |
  </Accordion>

  <Accordion title="A2A-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "tags.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
    ```

    Respons:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "tags.list",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "tags.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
        }
      }
    }
    ```

    Respons:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### `tags.update`

```text theme={null}
tags.update(account_id: str, tag_id: str, color_hex?: str | null, description?: str | null, tag_name?: str | null) -> Tag
```

Tags: `tags.update`.

| Eigenschap          | Waarde                                                 | Eigenschap            | Waarde       |
| ------------------- | ------------------------------------------------------ | --------------------- | ------------ |
| Vereiste machtiging | `tag.manage`                                           | Authenticatie vereist | `ja`         |
| Uitvoermodus        | `sync`                                                 | Mogelijkheid          | `tag.manage` |
| Resourcetype        | `account`                                              | Resource-ID-veld      | `account_id` |
| Openbare API-route  | `PATCH /v1/public/accounts/{account_id}/tags/{tag_id}` |                       |              |

<AccordionGroup>
  <Accordion title="Argumenten">
    | Naam          | Type          | Vereist |
    | ------------- | ------------- | ------- |
    | `account_id`  | `str`         | ja      |
    | `tag_id`      | `str`         | ja      |
    | `color_hex`   | `str \| null` | nee     |
    | `description` | `str \| null` | nee     |
    | `tag_name`    | `str \| null` | nee     |
  </Accordion>

  <Accordion title="Retourneert">
    | Veld          | Type          | Vereist |
    | ------------- | ------------- | ------- |
    | `color_hex`   | `str`         | ja      |
    | `id`          | `str`         | ja      |
    | `name`        | `str`         | ja      |
    | `created_at`  | `str \| null` | nee     |
    | `description` | `str \| null` | nee     |
    | `updated_at`  | `str \| null` | nee     |
  </Accordion>

  <Accordion title="A2A-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "request_id": "example",
      "session_id": "session_123",
      "code": "tags.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", color_hex=\"<string>\", description=\"<string>\", tag_name=\"<string>\")"
    }
    ```

    Respons:

    ```json theme={null}
    {
      "request_id": "example",
      "status": "completed",
      "result": {
        "last_value": "<string>"
      },
      "responses": [
        {
          "index": 0,
          "function": "tags.update",
          "status": "completed",
          "result": "<string>"
        }
      ],
      "complexity_score": 1
    }
    ```
  </Accordion>

  <Accordion title="MCP-voorbeeld">
    Aanvraag:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "method": "tools/call",
      "params": {
        "name": "hybridbox_execute",
        "arguments": {
          "code": "tags.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", tag_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", color_hex=\"<string>\", description=\"<string>\", tag_name=\"<string>\")"
        }
      }
    }
    ```

    Respons:

    ```json theme={null}
    {
      "jsonrpc": "2.0",
      "id": "example",
      "result": {
        "content": [
          {
            "type": "text",
            "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"tags.update\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
          }
        ],
        "isError": false
      }
    }
    ```
  </Accordion>
</AccordionGroup>