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

> Change an Attention field configuration's name, teams or criteria. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Change an Attention field configuration's name, teams or criteria.

> [!NOTE]
>
> Tool ID: `attention_update_field_configuration`

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

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute attention_update_field_configuration --input '{
  "id": "id_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "uuid": "uuid_123",
      "name": "Example",
      "organizationUUID": "organization_123",
      "teamsUUID": [
        "teams_123"
      ],
      "allTeams": true,
      "isDefaultTemplate": true,
      "createdAt": "2026-01-15T12:00:00Z"
    }
  }
}
```

Use `deepline describe attention_update_field_configuration --json` for the latest machine-readable contract.

## Input reference

Request payload for updating a field configuration. Uses PATCH semantics - only fields present in the body are updated. omitted fields are left unchanged.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | UUID of the field configuration. |
| `payload.name` | `string` | No | — | New human-readable name. When present, trimmed. 1-128 characters. |
| `payload.teamsUUID` | `array` | No | — | Replacement list of team UUIDs this configuration is assigned to. When omitted, existing assignments are preserved. |
| `payload.allTeams` | `boolean` | No | — | When present, sets whether the configuration applies to every team in the organization. |
| `payload.criteria` | `object` | No | — | Criteria expression that controls when this field configuration applies. Conditions are combined using the specified boolean operator. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request payload for updating a field configuration. Uses PATCH semantics - only fields present in the body are updated; omitted fields are left unchanged.",
    "properties": {
      "id": {
        "type": "string",
        "description": "UUID of the field configuration."
      },
      "name": {
        "type": "string",
        "description": "New human-readable name. When present, trimmed; 1-128 characters."
      },
      "teamsUUID": {
        "type": "array",
        "description": "Replacement list of team UUIDs this configuration is assigned to. When omitted, existing assignments are preserved.",
        "items": {
          "type": "string"
        }
      },
      "allTeams": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "When present, sets whether the configuration applies to every team in the organization."
      },
      "criteria": {
        "type": "object",
        "description": "Criteria expression that controls when this field configuration applies. Conditions are combined using the specified boolean operator.",
        "properties": {
          "conditions": {
            "type": "array",
            "description": "Ordered list of conditions to evaluate.",
            "items": {
              "type": "object",
              "description": "A single condition within a field-configuration criteria expression. Conditions reference a field name and the value it must match for an intelligence item to apply.",
              "properties": {
                "field": {
                  "type": "string",
                  "description": "Name of the field the condition applies to."
                },
                "value": {
                  "type": "string",
                  "description": "Value the field must match for this condition."
                }
              },
              "additionalProperties": false
            }
          },
          "operator": {
            "type": "string",
            "description": "Boolean operator used to combine the conditions.",
            "enum": [
              "AND",
              "OR"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Envelope containing a single field configuration. |
| `result.data.data` | `object` | No | — | A Field Configuration (internally `IntelligenceItemCollection`) groups a set of intelligence items that are surfaced together for the teams it is assigned to. Field Configurations are scoped to a single organization. |
| `result.data.data.uuid` | `string` | Yes | — | Unique identifier of the field configuration. |
| `result.data.data.name` | `string` | Yes | — | Human-readable name of the field configuration. |
| `result.data.data.organizationUUID` | `string` | Yes | — | UUID of the organization the field configuration belongs to. |
| `result.data.data.teamsUUID` | `array` | Yes | — | UUIDs of the teams this field configuration is assigned to. Ignored when `allTeams` is true. |
| `result.data.data.allTeams` | `boolean` | Yes | — | When true, this configuration applies to every team in the organization and `teamsUUID` is ignored. |
| `result.data.data.isDefaultTemplate` | `boolean` | Yes | — | Whether this configuration is the organization's default template. |
| `result.data.data.criteria` | `object` | No | — | Criteria expression that controls when this field configuration applies. Conditions are combined using the specified boolean operator. |
| `result.data.data.criteria.conditions` | `array` | No | — | Ordered list of conditions to evaluate. |
| `result.data.data.criteria.conditions[].field` | `string` | No | — | Name of the field the condition applies to. |
| `result.data.data.criteria.conditions[].value` | `string` | No | — | Value the field must match for this condition. |
| `result.data.data.criteria.operator` | `"AND" \| "OR"` | No | — | Boolean operator used to combine the conditions. Allowed: `AND`, `OR`. |
| `result.data.data.createdAt` | `string` | Yes | — | Timestamp when the configuration was created. Format: `date-time`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Envelope containing a single field configuration.",
        "properties": {
          "data": {
            "type": "object",
            "description": "A Field Configuration (internally `IntelligenceItemCollection`) groups a set of intelligence items that are surfaced together for the teams it is assigned to. Field Configurations are scoped to a single organization.",
            "properties": {
              "uuid": {
                "type": "string",
                "description": "Unique identifier of the field configuration."
              },
              "name": {
                "type": "string",
                "description": "Human-readable name of the field configuration."
              },
              "organizationUUID": {
                "type": "string",
                "description": "UUID of the organization the field configuration belongs to."
              },
              "teamsUUID": {
                "type": "array",
                "description": "UUIDs of the teams this field configuration is assigned to. Ignored when `allTeams` is true.",
                "items": {
                  "type": "string"
                }
              },
              "allTeams": {
                "type": "boolean",
                "description": "When true, this configuration applies to every team in the organization and `teamsUUID` is ignored."
              },
              "isDefaultTemplate": {
                "type": "boolean",
                "description": "Whether this configuration is the organization's default template."
              },
              "criteria": {
                "type": "object",
                "description": "Criteria expression that controls when this field configuration applies. Conditions are combined using the specified boolean operator.",
                "properties": {
                  "conditions": {
                    "type": "array",
                    "description": "Ordered list of conditions to evaluate.",
                    "items": {
                      "type": "object",
                      "description": "A single condition within a field-configuration criteria expression. Conditions reference a field name and the value it must match for an intelligence item to apply.",
                      "properties": {
                        "field": {
                          "type": "string",
                          "description": "Name of the field the condition applies to."
                        },
                        "value": {
                          "type": "string",
                          "description": "Value the field must match for this condition."
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "operator": {
                    "type": "string",
                    "description": "Boolean operator used to combine the conditions.",
                    "enum": [
                      "AND",
                      "OR"
                    ]
                  }
                },
                "additionalProperties": false
              },
              "createdAt": {
                "type": "string",
                "description": "Timestamp when the configuration was created.",
                "format": "date-time"
              }
            },
            "required": [
              "allTeams",
              "createdAt",
              "isDefaultTemplate",
              "name",
              "organizationUUID",
              "teamsUUID",
              "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](https://deepline.com/docs/providers/attention/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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