> ## 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

> Update Label. Attention Update Label reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Update Label.

<Info>
  Tool ID: `attention_update_label`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'attention_update_label',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

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

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "data": {
      "uuid": "uuid_123",
      "name": "Example",
      "aiFlow": true,
      "allTeams": true,
      "isDefaultTemplate": true,
      "organizationUUID": "organization_123",
      "createdAt": "2026-01-15T12:00:00Z"
    }
  }
}
```

Use `deepline tools get attention_update_label --json` for the latest machine-readable contract.

## Input reference

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.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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. Minimum length: 1. Maximum length: 128. |
| `payload.description` | `string` | No | — | New description. Pass an empty string to clear. 0 to 2000 characters. Omit to leave unchanged. Maximum length: 2000. |
| `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 reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Single-resource response envelope for label endpoints. |
| `result.data.data` | `object` | No | — | 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. |
| `result.data.data.uuid` | `string` | Yes | — | Unique identifier of the label. |
| `result.data.data.name` | `string` | Yes | — | Human-readable label name. Unique per organization. Trimmed; 1 to 128 characters. |
| `result.data.data.description` | `string` | No | — | Longer description of the label's meaning or criteria. 0 to 2000 characters. |
| `result.data.data.aiFlow` | `boolean` | Yes | — | Whether this label participates in the AI flow (auto-classification during conversation post-processing). |
| `result.data.data.allTeams` | `boolean` | Yes | — | Whether this label applies to all teams in the organization. When false, label visibility is constrained by team assignments managed through the internal API. |
| `result.data.data.isDefaultTemplate` | `boolean` | Yes | — | Whether this label originated from the organization's default template. Default-template labels are typically managed as a system-seeded group. |
| `result.data.data.options` | `array` | No | — | Optional set of selectable values when the label is a multi-value enum. Empty or omitted for binary labels. |
| `result.data.data.options[].value` | `string` | No | — | The option value as displayed to callers. Stored as an arbitrary JSON value server-side; surfaced here as a string for REST ergonomics. |
| `result.data.data.options[].description` | `string` | No | — | Optional human-readable description of the option, used for tooltips and AI-flow prompts. |
| `result.data.data.organizationUUID` | `string` | Yes | — | UUID of the organization that owns the label. Always matches the authenticated principal's organization on responses. |
| `result.data.data.createdAt` | `string` | Yes | — | Timestamp when the label was created, in ISO 8601 (RFC 3339) format. Format: `date-time`. |
| `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>

## Deepline cost

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

## Related documentation

* [Attention provider guide](/docs/providers/attention/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.