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

# Zoho CRM: Field Updates Get Field Update By ID

> To retrieve a field update action by fieldUpdate ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

To retrieve a field update action by fieldUpdate ID.

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

## 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(
  'zoho_crm_field_updates_get_field_update_by_id',
  {
    "id": "id_123",
    "include_inner_details": "field_label"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_field_updates_get_field_update_by_id --input '{
  "id": "id_123",
  "include_inner_details": "field_label"
}' --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": {
    "field_updates": [
      {
        "module": {
          "singular_label": "example",
          "moduleName": "Example",
          "id": "id_123"
        },
        "type": "static",
        "field": {
          "ui_type": 123,
          "id": "id_123",
          "api_name": "Example"
        },
        "name": "Example",
        "value": {}
      }
    ]
  }
}
```

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

## Input reference

Retrieves the details of the field-update action for the specified fieldUpdate ID.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Field Update action id in url path Maximum length: 255. |
| `payload.include_inner_details` | `"field_label" \| "enable_colour_code" \| "pick_list_values.colour_code" \| "data_type" \| "display_value"` | Yes | — | To retrieve additional details about the field associated with the field update. Allowed: `field_label`, `enable_colour_code`, `pick_list_values.colour_code`, `data_type`, `display_value`. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves the details of the field-update action for the specified fieldUpdate ID.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Field Update action id in url path",
        "maxLength": 255
      },
      "include_inner_details": {
        "type": "string",
        "description": "To retrieve additional details about the field associated with the field update.",
        "enum": [
          "field_label",
          "enable_colour_code",
          "pick_list_values.colour_code",
          "data_type",
          "display_value"
        ]
      }
    },
    "required": [
      "id",
      "include_inner_details"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | FieldUpdate GET API Success Response |
| `result.data.field_updates` | `array` | No | — | Field: field\_updates Maximum items: 1. |
| `result.data.field_updates[].created_time` | `string` | No | — | Field: created\_time Maximum length: 255. |
| `result.data.field_updates[].update_type` | `"overwrite" \| "append"` | No | — | Specify how to update the field. This key is supported only for the multi-select fields. Allowed: `overwrite`, `append`. Maximum length: 255. |
| `result.data.field_updates[].lock_status` | `object` | No | — | Nested schema for lock\_status |
| `result.data.field_updates[].lock_status.locked` | `boolean` | No | — | Field: locked |
| `result.data.field_updates[].apply_assignment_threshold` | `boolean` | No | — | Indicates whether assignment-threshold rules should be applied when updating the field. |
| `result.data.field_updates[].editable` | `boolean` | No | — | Field: editable |
| `result.data.field_updates[].module` | `object` | Yes | — | Specify the module details where the field update should be applied. |
| `result.data.field_updates[].module.singular_label` | `string` | No | — | Field: singular\_label Maximum length: 255. |
| `result.data.field_updates[].module.moduleName` | `string` | No | — | Field: moduleName Maximum length: 255. |
| `result.data.field_updates[].module.id` | `string` | No | — | Unique Id of the module Maximum length: 255. |
| `result.data.field_updates[].module.plural_label` | `string` | No | — | Field: plural\_label Maximum length: 255. |
| `result.data.field_updates[].module.api_name` | `string` | No | — | Name of the module Maximum length: 255. |
| `result.data.field_updates[].related_module` | `null` | No | — | Field: related\_module |
| `result.data.field_updates[].deletable` | `boolean` | No | — | Field: deletable |
| `result.data.field_updates[].source` | `string` | No | — | Field: source Maximum length: 255. |
| `result.data.field_updates[].type` | `"static"` | Yes | — | Specify the type of field update. (Required) Allowed: `static`. Maximum length: 255. |
| `result.data.field_updates[].created_by` | `object` | No | — | Nested schema for created\_by |
| `result.data.field_updates[].created_by.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.field_updates[].created_by.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.field_updates[].notify` | `boolean` | No | — | Specify whether or not to send email notifications to the new owner. |
| `result.data.field_updates[].feature_type` | `"workflow"` | No | — | Specify the automation feature in which you want to use the field update. Allowed: `workflow`. Maximum length: 255. |
| `result.data.field_updates[].modified_time` | `string` | No | — | Field: modified\_time Maximum length: 255. |
| `result.data.field_updates[].field` | `object` | Yes | — | Specify the API name and the unique ID of the field to be updated. |
| `result.data.field_updates[].field.ui_type` | `integer` | No | — | Field: ui\_type Format: `int32`. |
| `result.data.field_updates[].field.id` | `string` | No | — | Unique ID of the field to be updated. Maximum length: 255. |
| `result.data.field_updates[].field.api_name` | `string` | No | — | API name of the field to be updated. Maximum length: 255. |
| `result.data.field_updates[].dependent_fields` | `array` | No | — | Specify the dependent fields that are affected when the target field is updated Maximum items: 1. |
| `result.data.field_updates[].dependent_fields[].field` | `object` | Yes | — | Specify the API name and the unique ID of the field to be updated. |
| `result.data.field_updates[].dependent_fields[].field.ui_type` | `integer` | No | — | Field: ui\_type Format: `int32`. |
| `result.data.field_updates[].dependent_fields[].field.id` | `string` | No | — | Unique ID of the field to be updated. Maximum length: 255. |
| `result.data.field_updates[].dependent_fields[].field.api_name` | `string` | No | — | API name of the field to be updated. Maximum length: 255. |
| `result.data.field_updates[].dependent_fields[].value` | `string` | Yes | — | Contains value of the dependent field (Required) Maximum length: 255. |
| `result.data.field_updates[].related_records` | `array \| null` | No | — | Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated. Maximum items: 2. |
| `result.data.field_updates[].related_records[].api_name` | `string` | No | — | API name of the related record. Maximum length: 255. |
| `result.data.field_updates[].related_records[].id` | `string` | No | — | Unique id of the related rec Maximum length: 255. |
| `result.data.field_updates[].associated` | `boolean` | No | — | Field: associated |
| `result.data.field_updates[].name` | `string` | Yes | — | Specify the name of the field update action. (Required) Maximum length: 255. |
| `result.data.field_updates[].modified_by` | `object` | No | — | Nested schema for modified\_by |
| `result.data.field_updates[].modified_by.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.field_updates[].modified_by.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.field_updates[].id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.field_updates[].value` | `record` | Yes | — | Specify the value to set in the specified field. (Required) |
| `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": "FieldUpdate GET API Success Response",
        "properties": {
          "field_updates": {
            "type": "array",
            "description": "Field: field_updates",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Contains the data to create a field update action.",
              "properties": {
                "created_time": {
                  "type": "string",
                  "description": "Field: created_time",
                  "maxLength": 255
                },
                "update_type": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Specify how to update the field. This key is supported only for the multi-select fields.",
                  "maxLength": 255,
                  "enum": [
                    "overwrite",
                    "append"
                  ]
                },
                "lock_status": {
                  "type": "object",
                  "description": "Nested schema for lock_status",
                  "properties": {
                    "locked": {
                      "type": "boolean",
                      "description": "Field: locked"
                    }
                  },
                  "additionalProperties": false
                },
                "apply_assignment_threshold": {
                  "type": "boolean",
                  "description": "Indicates whether assignment-threshold rules should be applied when updating the field."
                },
                "editable": {
                  "type": "boolean",
                  "description": "Field: editable"
                },
                "module": {
                  "type": "object",
                  "description": "Specify the module details where the field update should be applied.",
                  "properties": {
                    "singular_label": {
                      "type": "string",
                      "description": "Field: singular_label",
                      "maxLength": 255
                    },
                    "moduleName": {
                      "type": "string",
                      "description": "Field: moduleName",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique Id of the module",
                      "maxLength": 255
                    },
                    "plural_label": {
                      "type": "string",
                      "description": "Field: plural_label",
                      "maxLength": 255
                    },
                    "api_name": {
                      "type": "string",
                      "description": "Name of the module",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "related_module": {
                  "type": "null",
                  "description": "Field: related_module"
                },
                "deletable": {
                  "type": "boolean",
                  "description": "Field: deletable"
                },
                "source": {
                  "type": "string",
                  "description": "Field: source",
                  "maxLength": 255
                },
                "type": {
                  "type": "string",
                  "description": "Specify the type of field update. (Required)",
                  "maxLength": 255,
                  "enum": [
                    "static"
                  ]
                },
                "created_by": {
                  "type": "object",
                  "description": "Nested schema for created_by",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "notify": {
                  "type": "boolean",
                  "description": "Specify whether or not to send email notifications to the new owner."
                },
                "feature_type": {
                  "type": "string",
                  "description": "Specify the automation feature in which you want to use the field update.",
                  "maxLength": 255,
                  "enum": [
                    "workflow"
                  ]
                },
                "modified_time": {
                  "type": "string",
                  "description": "Field: modified_time",
                  "maxLength": 255
                },
                "field": {
                  "type": "object",
                  "description": "Specify the API name and the unique ID of the field to be updated.",
                  "properties": {
                    "ui_type": {
                      "type": "integer",
                      "description": "Field: ui_type",
                      "format": "int32"
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique ID of the field to be updated.",
                      "maxLength": 255
                    },
                    "api_name": {
                      "type": "string",
                      "description": "API name of the field to be updated.",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "dependent_fields": {
                  "type": "array",
                  "description": "Specify the dependent fields that are affected when the target field is updated",
                  "maxItems": 1,
                  "items": {
                    "type": "object",
                    "description": "Specify the dependent fields that are affected when the target field is updated",
                    "properties": {
                      "field": {
                        "type": "object",
                        "description": "Specify the API name and the unique ID of the field to be updated.",
                        "properties": {
                          "ui_type": {
                            "type": "integer",
                            "description": "Field: ui_type",
                            "format": "int32"
                          },
                          "id": {
                            "type": "string",
                            "description": "Unique ID of the field to be updated.",
                            "maxLength": 255
                          },
                          "api_name": {
                            "type": "string",
                            "description": "API name of the field to be updated.",
                            "maxLength": 255
                          }
                        },
                        "additionalProperties": false
                      },
                      "value": {
                        "type": "string",
                        "description": "Contains value of the dependent field (Required)",
                        "maxLength": 255
                      }
                    },
                    "required": [
                      "field",
                      "value"
                    ],
                    "additionalProperties": false
                  }
                },
                "related_records": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "description": "Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated.",
                  "maxItems": 2,
                  "items": {
                    "type": "object",
                    "description": "Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated.",
                    "properties": {
                      "api_name": {
                        "type": "string",
                        "description": "API name of the related record.",
                        "maxLength": 255
                      },
                      "id": {
                        "type": "string",
                        "description": "Unique id of the related rec",
                        "maxLength": 255
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "associated": {
                  "type": "boolean",
                  "description": "Field: associated"
                },
                "name": {
                  "type": "string",
                  "description": "Specify the name of the field update action. (Required)",
                  "maxLength": 255
                },
                "modified_by": {
                  "type": "object",
                  "description": "Nested schema for modified_by",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "id": {
                  "type": "string",
                  "description": "Field: id",
                  "maxLength": 255
                },
                "value": {
                  "type": "object",
                  "description": "Specify the value to set in the specified field. (Required)",
                  "additionalProperties": true
                }
              },
              "required": [
                "field",
                "module",
                "name",
                "type",
                "value"
              ],
              "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

* [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.