> ## 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: Bulk Write Get Job Details

> Check the status and results of a Zoho CRM bulk import job by its ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Check the status and results of a Zoho CRM bulk import job by its ID.

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

## 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_bulk_write_get_job_details',
  {
    "jobId": "job_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_bulk_write_get_job_details --input '{
  "jobId": "job_123"
}' --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": {
    "status": "example",
    "resource": [
      {
        "status": "COMPLETED",
        "type": "data",
        "module": {
          "api_name": "Example"
        }
      }
    ],
    "id": "id_123",
    "created_by": {
      "name": "Example",
      "id": "id_123"
    },
    "operation": "example",
    "created_time": "2026-01-15T12:00:00Z",
    "callback": {
      "url": "http://requestbin.fullcontact.com/1fcimk51",
      "method": "post"
    }
  }
}
```

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

## Input reference

To upload a CSV file in ZIP format for bulk write API. The response contains the file\_id. Use this ID while making the bulk write request.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.jobId` | `string` | Yes | — | Unique identifier of the bulk write job Maximum length: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To upload a CSV file in ZIP format for bulk write API. The response contains the file_id. Use this ID while making the bulk write request.",
    "properties": {
      "jobId": {
        "type": "string",
        "description": "Unique identifier of the bulk write job",
        "maxLength": 100
      }
    },
    "required": [
      "jobId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Bulk write job details response |
| `result.data.status` | `string` | Yes | — | Status of the bulk write job Maximum length: 50. |
| `result.data.character_encoding` | `string` | No | — | Character encoding used for the file Maximum length: 50. |
| `result.data.resource` | `array` | Yes | — | List of resources processed in the bulk write job Maximum items: 100. |
| `result.data.resource[].status` | `"COMPLETED" \| "ADDED" \| "INPROGRESS" \| "SKIPPED"` | Yes | — | Status of the resource processing Allowed: `COMPLETED`, `ADDED`, `INPROGRESS`, `SKIPPED`. |
| `result.data.resource[].type` | `"data"` | Yes | — | Type of resource Allowed: `data`. |
| `result.data.resource[].module` | `object` | Yes | — | Module information |
| `result.data.resource[].module.api_name` | `string` | Yes | — | API name of the module Maximum length: 100. |
| `result.data.resource[].module.id` | `string` | No | — | Module ID Maximum length: 100. |
| `result.data.resource[].ignore_empty` | `boolean` | No | — | Whether empty values are ignored |
| `result.data.resource[].field_mappings` | `array` | No | — | Field mapping configuration Maximum items: 500. |
| `result.data.resource[].field_mappings[].api_name` | `string` | Yes | — | API name of the field Maximum length: 100. |
| `result.data.resource[].field_mappings[].index` | `integer` | Yes | — | Column index in the file Format: `int32`. |
| `result.data.resource[].field_mappings[].format` | `string \| null` | No | — | Format of the field value Maximum length: 100. |
| `result.data.resource[].field_mappings[].find_by` | `string \| null` | No | — | Field to find records by Maximum length: 100. |
| `result.data.resource[].field_mappings[].default_value` | `object` | No | — | Default value configuration |
| `result.data.resource[].field_mappings[].default_value.value` | `string` | Yes | — | Default value Maximum length: 500. |
| `result.data.resource[].field_mappings[].parent_column_index` | `integer \| null` | No | — | Parent column index for related fields Format: `int32`. |
| `result.data.resource[].field_mappings[].module` | `string \| null` | No | — | Related module name Maximum length: 100. |
| `result.data.resource[].file` | `object` | No | — | File processing details |
| `result.data.resource[].file.status` | `"COMPLETED" \| "ADDED" \| "INPROGRESS" \| "SKIPPED"` | Yes | — | File processing status Allowed: `COMPLETED`, `ADDED`, `INPROGRESS`, `SKIPPED`. |
| `result.data.resource[].file.name` | `string` | Yes | — | File name Maximum length: 255. |
| `result.data.resource[].file.added_count` | `integer` | Yes | — | Number of records added Format: `int32`. |
| `result.data.resource[].file.skipped_count` | `integer` | Yes | — | Number of records skipped Format: `int32`. |
| `result.data.resource[].file.updated_count` | `integer` | Yes | — | Number of records updated Format: `int32`. |
| `result.data.resource[].file.total_count` | `integer` | Yes | — | Total number of records Format: `int32`. |
| `result.data.resource[].code` | `string` | No | — | Response code Maximum length: 100. |
| `result.data.id` | `string` | Yes | — | Bulk write job ID Maximum length: 100. |
| `result.data.result` | `object` | No | — | Job result details |
| `result.data.result.download_url` | `string` | Yes | — | URL to download the result Maximum length: 500. |
| `result.data.created_by` | `object` | Yes | — | User who created the job |
| `result.data.created_by.name` | `string` | Yes | — | User name Maximum length: 100. |
| `result.data.created_by.id` | `string` | Yes | — | User ID Maximum length: 100. |
| `result.data.operation` | `string` | Yes | — | Type of operation performed Maximum length: 50. |
| `result.data.created_time` | `string` | Yes | — | Job creation timestamp Format: `date-time`. |
| `result.data.callback` | `object` | Yes | — | Callback configuration |
| `result.data.callback.url` | `"http://requestbin.fullcontact.com/1fcimk51"` | Yes | — | Callback URL Allowed: `http://requestbin.fullcontact.com/1fcimk51`. |
| `result.data.callback.method` | `"post"` | Yes | — | Callback HTTP method Allowed: `post`. |
| `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": "Bulk write job details response",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the bulk write job",
            "maxLength": 50
          },
          "character_encoding": {
            "type": "string",
            "description": "Character encoding used for the file",
            "maxLength": 50
          },
          "resource": {
            "type": "array",
            "description": "List of resources processed in the bulk write job",
            "maxItems": 100,
            "items": {
              "type": "object",
              "description": "Resource details",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Status of the resource processing",
                  "enum": [
                    "COMPLETED",
                    "ADDED",
                    "INPROGRESS",
                    "SKIPPED"
                  ]
                },
                "type": {
                  "type": "string",
                  "description": "Type of resource",
                  "enum": [
                    "data"
                  ]
                },
                "module": {
                  "type": "object",
                  "description": "Module information",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "API name of the module",
                      "maxLength": 100
                    },
                    "id": {
                      "type": "string",
                      "description": "Module ID",
                      "maxLength": 100
                    }
                  },
                  "required": [
                    "api_name"
                  ],
                  "additionalProperties": false
                },
                "ignore_empty": {
                  "type": "boolean",
                  "description": "Whether empty values are ignored"
                },
                "field_mappings": {
                  "type": "array",
                  "description": "Field mapping configuration",
                  "maxItems": 500,
                  "items": {
                    "type": "object",
                    "description": "Individual field mapping",
                    "properties": {
                      "api_name": {
                        "type": "string",
                        "description": "API name of the field",
                        "maxLength": 100
                      },
                      "index": {
                        "type": "integer",
                        "description": "Column index in the file",
                        "format": "int32"
                      },
                      "format": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Format of the field value",
                        "maxLength": 100
                      },
                      "find_by": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Field to find records by",
                        "maxLength": 100
                      },
                      "default_value": {
                        "type": "object",
                        "description": "Default value configuration",
                        "properties": {
                          "value": {
                            "type": "string",
                            "description": "Default value",
                            "maxLength": 500
                          }
                        },
                        "required": [
                          "value"
                        ],
                        "additionalProperties": false
                      },
                      "parent_column_index": {
                        "type": [
                          "integer",
                          "null"
                        ],
                        "description": "Parent column index for related fields",
                        "format": "int32"
                      },
                      "module": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "Related module name",
                        "maxLength": 100
                      }
                    },
                    "required": [
                      "api_name",
                      "index"
                    ],
                    "additionalProperties": false
                  }
                },
                "file": {
                  "type": "object",
                  "description": "File processing details",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "File processing status",
                      "enum": [
                        "COMPLETED",
                        "ADDED",
                        "INPROGRESS",
                        "SKIPPED"
                      ]
                    },
                    "name": {
                      "type": "string",
                      "description": "File name",
                      "maxLength": 255
                    },
                    "added_count": {
                      "type": "integer",
                      "description": "Number of records added",
                      "format": "int32"
                    },
                    "skipped_count": {
                      "type": "integer",
                      "description": "Number of records skipped",
                      "format": "int32"
                    },
                    "updated_count": {
                      "type": "integer",
                      "description": "Number of records updated",
                      "format": "int32"
                    },
                    "total_count": {
                      "type": "integer",
                      "description": "Total number of records",
                      "format": "int32"
                    }
                  },
                  "required": [
                    "status",
                    "name",
                    "added_count",
                    "skipped_count",
                    "updated_count",
                    "total_count"
                  ],
                  "additionalProperties": false
                },
                "code": {
                  "type": "string",
                  "description": "Response code",
                  "maxLength": 100
                }
              },
              "required": [
                "status",
                "type",
                "module"
              ],
              "additionalProperties": false
            }
          },
          "id": {
            "type": "string",
            "description": "Bulk write job ID",
            "maxLength": 100
          },
          "result": {
            "type": "object",
            "description": "Job result details",
            "properties": {
              "download_url": {
                "type": "string",
                "description": "URL to download the result",
                "maxLength": 500
              }
            },
            "required": [
              "download_url"
            ],
            "additionalProperties": false
          },
          "created_by": {
            "type": "object",
            "description": "User who created the job",
            "properties": {
              "name": {
                "type": "string",
                "description": "User name",
                "maxLength": 100
              },
              "id": {
                "type": "string",
                "description": "User ID",
                "maxLength": 100
              }
            },
            "required": [
              "name",
              "id"
            ],
            "additionalProperties": false
          },
          "operation": {
            "type": "string",
            "description": "Type of operation performed",
            "maxLength": 50
          },
          "created_time": {
            "type": "string",
            "description": "Job creation timestamp",
            "format": "date-time"
          },
          "callback": {
            "type": "object",
            "description": "Callback configuration",
            "properties": {
              "url": {
                "type": "string",
                "description": "Callback URL",
                "enum": [
                  "http://requestbin.fullcontact.com/1fcimk51"
                ]
              },
              "method": {
                "type": "string",
                "description": "Callback HTTP method",
                "enum": [
                  "post"
                ]
              }
            },
            "required": [
              "url",
              "method"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "status",
          "resource",
          "id",
          "created_by",
          "operation",
          "created_time",
          "callback"
        ],
        "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.