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

# Attention Update Label: Inputs, Cost & CLI Example

> Update Label. Attention Attention Update Label docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=attention_update_label:{"id":"{{id}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                  | Type      | Required | Default | Description                                                                                                                                                                                       |
| --------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.id`          | `string`  | Yes      |         | UUID of the label to update.                                                                                                                                                                      |
| `payload.name`        | `string`  | No       |         | New label name. Trimmed before validation. Must be unique within the organization. Renaming cascades to scorecard criteria and intelligence-item-collection criteria that reference the old name. |
| `payload.description` | `string`  | No       |         | New description. Pass an empty string to clear. 0 to 2000 characters. Omit to leave unchanged.                                                                                                    |
| `payload.aiFlow`      | `boolean` | No       |         | New AI-flow participation value. Omit to leave unchanged.                                                                                                                                         |
| `payload.allTeams`    | `boolean` | No       |         | New allTeams value. Omit to leave unchanged.                                                                                                                                                      |
| `payload.options`     | `array`   | No       |         | New option set. When provided, the full list replaces the existing options. Omit to leave unchanged; send an empty array to clear.                                                                |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Payload for partially updating a label. Only fields present in the body are applied (pointer-nil merge semantics). At least one mutable field must be provided.",
    "properties": {
      "id": {
        "type": "string",
        "description": "UUID of the label to update."
      },
      "name": {
        "type": "string",
        "description": "New label name. Trimmed before validation. Must be unique within the organization. Renaming cascades to scorecard criteria and intelligence-item-collection criteria that reference the old name.",
        "minLength": 1,
        "maxLength": 128
      },
      "description": {
        "type": [
          "string",
          "null"
        ],
        "description": "New description. Pass an empty string to clear. 0 to 2000 characters. Omit to leave unchanged.",
        "maxLength": 2000
      },
      "aiFlow": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "New AI-flow participation value. Omit to leave unchanged."
      },
      "allTeams": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "New allTeams value. Omit to leave unchanged."
      },
      "options": {
        "type": "array",
        "description": "New option set. When provided, the full list replaces the existing options. Omit to leave unchanged; send an empty array to clear.",
        "items": {
          "type": "object",
          "description": "A single selectable value within a label's option set. Present when the label is configured as a multi-value enum.",
          "properties": {
            "value": {
              "type": "string",
              "description": "The option value as displayed to callers. Stored as an arbitrary JSON value server-side; surfaced here as a string for REST ergonomics."
            },
            "description": {
              "type": "string",
              "description": "Optional human-readable description of the option, used for tooltips and AI-flow prompts."
            }
          },
          "additionalProperties": false
        }
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                            |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------ |
| `result.data` | `object` | Yes      |         | Single-resource response envelope for label endpoints. |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging).         |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Single-resource response envelope for label endpoints.",
        "properties": {
          "data": {
            "type": "object",
            "description": "A label (label category) used to classify conversations and drive AI flows, scorecard criteria, and intelligence-item-collection criteria. Labels are scoped to a single organization.",
            "properties": {
              "uuid": {
                "type": "string",
                "description": "Unique identifier of the label."
              },
              "name": {
                "type": "string",
                "description": "Human-readable label name. Unique per organization. Trimmed; 1 to 128 characters."
              },
              "description": {
                "type": "string",
                "description": "Longer description of the label's meaning or criteria. 0 to 2000 characters."
              },
              "aiFlow": {
                "type": "boolean",
                "description": "Whether this label participates in the AI flow (auto-classification during conversation post-processing)."
              },
              "allTeams": {
                "type": "boolean",
                "description": "Whether this label applies to all teams in the organization. When false, label visibility is constrained by team assignments managed through the internal API."
              },
              "isDefaultTemplate": {
                "type": "boolean",
                "description": "Whether this label originated from the organization's default template. Default-template labels are typically managed as a system-seeded group."
              },
              "options": {
                "type": "array",
                "description": "Optional set of selectable values when the label is a multi-value enum. Empty or omitted for binary labels.",
                "items": {
                  "type": "object",
                  "description": "A single selectable value within a label's option set. Present when the label is configured as a multi-value enum.",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "The option value as displayed to callers. Stored as an arbitrary JSON value server-side; surfaced here as a string for REST ergonomics."
                    },
                    "description": {
                      "type": "string",
                      "description": "Optional human-readable description of the option, used for tooltips and AI-flow prompts."
                    }
                  },
                  "additionalProperties": false
                }
              },
              "organizationUUID": {
                "type": "string",
                "description": "UUID of the organization that owns the label. Always matches the authenticated principal's organization on responses."
              },
              "createdAt": {
                "type": "string",
                "description": "Timestamp when the label was created, in ISO 8601 (RFC 3339) format.",
                "format": "date-time"
              }
            },
            "required": [
              "aiFlow",
              "allTeams",
              "createdAt",
              "isDefaultTemplate",
              "name",
              "organizationUUID",
              "uuid"
            ],
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute attention_update_label --payload '{
  "id": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.
