Attention: Update Label

Change an Attention conversation label’s name, description or options.

Tool ID: attention_update_label

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

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

deepline tools execute attention_update_label --input '{
  "id": "id_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

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

Use deepline describe 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.

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).

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation