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

> Retrieve the status of a mass update job. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve the status of a mass update job.

<Info>
  Tool ID: `zoho_crm_mass_update_get_mass_update_status`
</Info>

## Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example.

Inspect the live contract before executing it:

```bash theme={null}
deepline tools get zoho_crm_mass_update_get_mass_update_status --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "data": [
      {
        "Status": "COMPLETED",
        "Failed_Count": 123,
        "Updated_Count": 123,
        "Not_Updated_Count": 123,
        "Total_Count": 123
      }
    ]
  }
}
```

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

## Input reference

Retrieves the current status and progress metrics of an asynchronous mass update job initiated via POST /crm/v8/\&#123;module\&#125;/actions/mass\_update. Returns record counts and current job state.

| Name             | Type                                                                                                                                                                                                                                                   | Required | Default | Details                                                                                                                                                                                                                                                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.module` | `"Leads" \| "Accounts" \| "Contacts" \| "Deals" \| "Campaigns" \| "Tasks" \| "Calls" \| "Meetings" \| "Cases" \| "Solutions" \| "Products" \| "Vendors" \| "Price_Books" \| "Quotes" \| "Sales_Orders" \| "Purchase_Orders" \| "Invoices" \| "Custom"` | Yes      | —       | Specifies the CRM module for the mass update operation. Note: Module names are case-sensitive. Allowed: `Leads`, `Accounts`, `Contacts`, `Deals`, `Campaigns`, `Tasks`, `Calls`, `Meetings`, `Cases`, `Solutions`, `Products`, `Vendors`, `Price_Books`, `Quotes`, `Sales_Orders`, `Purchase_Orders`, `Invoices`, `Custom`. |
| `payload.job_id` | `string`                                                                                                                                                                                                                                               | Yes      | —       | Job identifier for the asynchronous mass update operation initiated via POST. Used to retrieve operation status and result counts. Format: `int64`. Pattern: `^[0-9]+$`.                                                                                                                                                    |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieves the current status and progress metrics of an asynchronous mass update job initiated via POST /crm/v8/\\{module\\}/actions/mass_update. Returns record counts and current job state.",
    "properties": {
      "module": {
        "type": "string",
        "description": "Specifies the CRM module for the mass update operation. Note: Module names are case-sensitive.",
        "enum": [
          "Leads",
          "Accounts",
          "Contacts",
          "Deals",
          "Campaigns",
          "Tasks",
          "Calls",
          "Meetings",
          "Cases",
          "Solutions",
          "Products",
          "Vendors",
          "Price_Books",
          "Quotes",
          "Sales_Orders",
          "Purchase_Orders",
          "Invoices",
          "Custom"
        ]
      },
      "job_id": {
        "type": "string",
        "description": "Job identifier for the asynchronous mass update operation initiated via POST. Used to retrieve operation status and result counts.",
        "pattern": "^[0-9]+$",
        "format": "int64"
      }
    },
    "required": [
      "module",
      "job_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                   | Type                                                                             | Required | Default | Details                                                                                                                    |
| -------------------------------------- | -------------------------------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `result.data`                          | `object`                                                                         | Yes      | —       | Successfully retrieved the mass update job status, including current state and record processing counts.                   |
| `result.data.data`                     | `array`                                                                          | Yes      | —       | Successfully retrieved the mass update job status, including current state and record processing counts. Maximum items: 1. |
| `result.data.data[].Status`            | `"COMPLETED" \| "SCHEDULED" \| "QUEUED" \| "RUNNING" \| "SUSPENDED" \| "FAILED"` | Yes      | —       | Current state of the mass update job Allowed: `COMPLETED`, `SCHEDULED`, `QUEUED`, `RUNNING`, `SUSPENDED`, `FAILED`.        |
| `result.data.data[].Failed_Count`      | `integer`                                                                        | Yes      | —       | Number of records that failed to update due to validation or other errors Format: `int32`.                                 |
| `result.data.data[].Updated_Count`     | `integer`                                                                        | Yes      | —       | Number of records successfully updated Format: `int32`.                                                                    |
| `result.data.data[].Not_Updated_Count` | `integer`                                                                        | Yes      | —       | Number of records pending update or skipped Format: `int32`.                                                               |
| `result.data.data[].Total_Count`       | `integer`                                                                        | Yes      | —       | Total number of records submitted for mass update Format: `int32`.                                                         |
| `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": "Successfully retrieved the mass update job status, including current state and record processing counts.",
        "properties": {
          "data": {
            "type": "array",
            "description": "Successfully retrieved the mass update job status, including current state and record processing counts.",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Contains the mass update job status, including Status, Failed_Count, Updated_Count, Not_Updated_Count, and Total_Count.",
              "properties": {
                "Status": {
                  "type": "string",
                  "description": "Current state of the mass update job",
                  "enum": [
                    "COMPLETED",
                    "SCHEDULED",
                    "QUEUED",
                    "RUNNING",
                    "SUSPENDED",
                    "FAILED"
                  ]
                },
                "Failed_Count": {
                  "type": "integer",
                  "description": "Number of records that failed to update due to validation or other errors",
                  "format": "int32"
                },
                "Updated_Count": {
                  "type": "integer",
                  "description": "Number of records successfully updated",
                  "format": "int32"
                },
                "Not_Updated_Count": {
                  "type": "integer",
                  "description": "Number of records pending update or skipped",
                  "format": "int32"
                },
                "Total_Count": {
                  "type": "integer",
                  "description": "Total number of records submitted for mass update",
                  "format": "int32"
                }
              },
              "required": [
                "Failed_Count",
                "Updated_Count",
                "Total_Count",
                "Not_Updated_Count",
                "Status"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "data"
        ],
        "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)