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

> Update Share Records. Zoho CRM Share Records Update Share Records reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline.

Update Share Records.

<Info>
  Tool ID: `zoho_crm_share_records_update_share_records`
</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_share_records_update_share_records',
  {
    "moduleApiName": "Example",
    "recordId": "record_123",
    "share": [
      {
        "type": "private",
        "permission": "read_only",
        "shared_with": {
          "type": "roles",
          "id": "id_123"
        }
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_share_records_update_share_records --input '{
  "moduleApiName": "Example",
  "recordId": "record_123",
  "share": [
    {
      "type": "private",
      "permission": "read_only",
      "shared_with": {
        "type": "roles",
        "id": "id_123"
      }
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "share": [
      {
        "code": "SUCCESS",
        "details": {},
        "message": "record will be shared successfully",
        "status": "success"
      }
    ]
  }
}
```

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

## Input reference

Update Share Records Request

| Name                            | Type      | Required | Default | Details                                        |
| ------------------------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `payload.moduleApiName`         | `string`  | Yes      | —       | API name of the module Maximum length: 100.    |
| `payload.recordId`              | `string`  | Yes      | —       | ID of the record Maximum length: 20.           |
| `payload.share`                 | `array`   | Yes      | —       | additional information Maximum items: 20.      |
| `payload.notify_shared_members` | `boolean` | No       | —       | indicates whether to notify the shared members |
| `payload.notify_on_completion`  | `boolean` | No       | —       | indicates whether to notify on completion      |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Update Share Records Request",
    "properties": {
      "moduleApiName": {
        "type": "string",
        "description": "API name of the module",
        "maxLength": 100
      },
      "recordId": {
        "type": "string",
        "description": "ID of the record",
        "maxLength": 20
      },
      "share": {
        "type": "array",
        "description": "additional information",
        "maxItems": 20,
        "items": {
          "type": "object",
          "description": "share record details",
          "properties": {
            "type": {
              "type": "string",
              "description": "type of sharing",
              "enum": [
                "private",
                "public"
              ]
            },
            "share_related_records": {
              "type": "boolean",
              "description": "indicates if related records are shared"
            },
            "permission": {
              "type": "string",
              "description": "level of access granted",
              "enum": [
                "read_only",
                "read_write",
                "full_access"
              ]
            },
            "shared_with": {
              "type": "object",
              "description": "details of whom the record is shared with",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "type of entity with whom the record is shared",
                  "enum": [
                    "roles",
                    "groups",
                    "users"
                  ]
                },
                "id": {
                  "type": "string",
                  "description": "id of the entity with whom the record is shared",
                  "maxLength": 20
                }
              },
              "required": [
                "type",
                "id"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "type",
            "permission",
            "shared_with"
          ],
          "additionalProperties": false
        }
      },
      "notify_shared_members": {
        "type": "boolean",
        "description": "indicates whether to notify the shared members"
      },
      "notify_on_completion": {
        "type": "boolean",
        "description": "indicates whether to notify on completion"
      }
    },
    "required": [
      "moduleApiName",
      "recordId",
      "share"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                          | Type                                   | Required | Default | Details                                                         |
| ----------------------------- | -------------------------------------- | -------- | ------- | --------------------------------------------------------------- |
| `result.data`                 | `object`                               | Yes      | —       | Update Share Records Success Response                           |
| `result.data.share`           | `array`                                | No       | —       | list of share record update responses Maximum items: 20.        |
| `result.data.share[].code`    | `"SUCCESS"`                            | Yes      | —       | response code Allowed: `SUCCESS`.                               |
| `result.data.share[].details` | `record`                               | Yes      | —       | additional information                                          |
| `result.data.share[].message` | `"record will be shared successfully"` | Yes      | —       | response message Allowed: `record will be shared successfully`. |
| `result.data.share[].status`  | `"success"`                            | Yes      | —       | response status Allowed: `success`.                             |
| `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": "Update Share Records Success Response",
        "properties": {
          "share": {
            "type": "array",
            "description": "list of share record update responses",
            "maxItems": 20,
            "items": {
              "type": "object",
              "description": "share record update response details",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "response code",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "additional information",
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "response message",
                  "enum": [
                    "record will be shared successfully"
                  ]
                },
                "status": {
                  "type": "string",
                  "description": "response status",
                  "enum": [
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "details",
                "message",
                "status"
              ],
              "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)