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

> To update an existing field update action. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

To update an existing field update action.

<Info>
  Tool ID: `zoho_crm_field_updates_put_field_update_by_id`
</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(
  'zoho_crm_field_updates_put_field_update_by_id',
  {
    "id": "id_123",
    "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": {}
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_field_updates_put_field_update_by_id --input '{
  "id": "id_123",
  "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": {}
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "field_updates": [
      {
        "code": "example",
        "details": {
          "id": "id_123"
        },
        "message": "Example message"
      }
    ]
  }
}
```

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

## Input reference

Request body schema

| Name                    | Type     | Required | Default | Details                                                                         |
| ----------------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `payload.id`            | `string` | Yes      | —       | Field Update action id in url path Maximum length: 255.                         |
| `payload.field_updates` | `array`  | Yes      | —       | Contains the data to create a field update action. (Required) Maximum items: 1. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Request body schema",
    "properties": {
      "id": {
        "type": "string",
        "description": "Field Update action id in url path",
        "maxLength": 255
      },
      "field_updates": {
        "type": "array",
        "description": "Contains the data to create a field update action. (Required)",
        "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
        }
      }
    },
    "required": [
      "id",
      "field_updates"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                     | Type     | Required | Default | Details                                                          |
| ---------------------------------------- | -------- | -------- | ------- | ---------------------------------------------------------------- |
| `result.data`                            | `object` | Yes      | —       | Represents the success response for a field update modification. |
| `result.data.field_updates`              | `array`  | No       | —       | Field: field\_updates Maximum items: 1.                          |
| `result.data.field_updates[].code`       | `string` | No       | —       | Field: code Maximum length: 255.                                 |
| `result.data.field_updates[].details`    | `object` | No       | —       | Nested schema for details                                        |
| `result.data.field_updates[].details.id` | `string` | No       | —       | Field: id Maximum length: 255.                                   |
| `result.data.field_updates[].message`    | `string` | No       | —       | Field: message Maximum length: 255.                              |
| `result.data.field_updates[].status`     | `string` | No       | —       | Field: status Maximum length: 255.                               |
| `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": "Represents the success response for a field update modification.",
        "properties": {
          "field_updates": {
            "type": "array",
            "description": "Field: field_updates",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Nested schema for field_updates",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Field: code",
                  "maxLength": 255
                },
                "details": {
                  "type": "object",
                  "description": "Nested schema for details",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Field: id",
                      "maxLength": 255
                    }
                  },
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Field: message",
                  "maxLength": 255
                },
                "status": {
                  "type": "string",
                  "description": "Field: status",
                  "maxLength": 255
                }
              },
              "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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)