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

> Trigger organization-level enrichment for a CRM record. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Trigger organization-level enrichment for a CRM record.

<Info>
  Tool ID: `zoho_crm_zia_org_enrichment_submit_org_enrichment_request`
</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_zia_org_enrichment_submit_org_enrichment_request',
  {
    "module": "example",
    "__zia_org_enrichment": [
      {
        "enrich_based_on": {
          "name": "Example"
        }
      }
    ]
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_zia_org_enrichment_submit_org_enrichment_request --input '{
  "module": "example",
  "__zia_org_enrichment": [
    {
      "enrich_based_on": {
        "name": "Example"
      }
    }
  ]
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "__zia_org_enrichment": [
      {
        "code": "SCHEDULED",
        "details": {
          "id": "id_123"
        },
        "message": "Example message",
        "status": "success"
      }
    ]
  }
}
```

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

## Input reference

Request body for organization enrichment.

| Name                           | Type     | Required | Default | Details                                                                           |
| ------------------------------ | -------- | -------- | ------- | --------------------------------------------------------------------------------- |
| `payload.module`               | `string` | Yes      | —       | CRM module name from which enrichment is triggered. Maximum length: 255.          |
| `payload.record_id`            | `string` | No       | —       | Unique CRM record ID for which enrichment is requested. Maximum length: 19.       |
| `payload.__zia_org_enrichment` | `array`  | Yes      | —       | List of input objects used to trigger organization enrichment. Maximum items: 50. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Request body for organization enrichment.",
    "properties": {
      "module": {
        "type": "string",
        "description": "CRM module name from which enrichment is triggered.",
        "maxLength": 255
      },
      "record_id": {
        "type": "string",
        "description": "Unique CRM record ID for which enrichment is requested.",
        "maxLength": 19
      },
      "__zia_org_enrichment": {
        "type": "array",
        "description": "List of input objects used to trigger organization enrichment.",
        "maxItems": 50,
        "items": {
          "type": "object",
          "description": "Organization enrichment input object.",
          "properties": {
            "enrich_based_on": {
              "type": "object",
              "description": "Fields used to identify and enrich the organization.",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the organization used for enrichment.",
                  "maxLength": 255
                },
                "email": {
                  "type": "string",
                  "description": "Email address used to enrich organization details.",
                  "format": "email"
                },
                "website": {
                  "type": "string",
                  "description": "Website domain used for organization enrichment.",
                  "format": "website"
                }
              },
              "required": [
                "name"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "enrich_based_on"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "module",
      "__zia_org_enrichment"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                            | Type          | Required | Default | Details                                                                         |
| ----------------------------------------------- | ------------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `result.data`                                   | `object`      | Yes      | —       | Org Enrichment scheduled successfully                                           |
| `result.data.__zia_org_enrichment`              | `array`       | Yes      | —       | Response key Maximum items: 50.                                                 |
| `result.data.__zia_org_enrichment[].code`       | `"SCHEDULED"` | Yes      | —       | Indicates the scheduling status of the enrichment job Allowed: `SCHEDULED`.     |
| `result.data.__zia_org_enrichment[].details`    | `object`      | Yes      | —       | Additional information about the enrichment job                                 |
| `result.data.__zia_org_enrichment[].details.id` | `string`      | Yes      | —       | Unique identifier assigned to the scheduled enrichment job Maximum length: 255. |
| `result.data.__zia_org_enrichment[].message`    | `string`      | Yes      | —       | Readable message describing the result of the request Maximum length: 255.      |
| `result.data.__zia_org_enrichment[].status`     | `"success"`   | Yes      | —       | Indicates whether the request was successful or failed 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": "Org Enrichment scheduled successfully",
        "properties": {
          "__zia_org_enrichment": {
            "type": "array",
            "description": "Response key",
            "maxItems": 50,
            "items": {
              "type": "object",
              "description": "List containing organization enrichment job status",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "Indicates the scheduling status of the enrichment job",
                  "enum": [
                    "SCHEDULED"
                  ]
                },
                "details": {
                  "type": "object",
                  "description": "Additional information about the enrichment job",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier assigned to the scheduled enrichment job",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                "message": {
                  "type": "string",
                  "description": "Readable message describing the result of the request",
                  "maxLength": 255
                },
                "status": {
                  "type": "string",
                  "description": "Indicates whether the request was successful or failed",
                  "enum": [
                    "success"
                  ]
                }
              },
              "required": [
                "code",
                "details",
                "message",
                "status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "__zia_org_enrichment"
        ],
        "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)