> ## 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 Create Bulk Write Job

> Start a bulk import that inserts, updates or upserts Zoho CRM records from an uploaded CSV file. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Start a bulk import that inserts, updates or upserts Zoho CRM records from an uploaded CSV file.

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

## 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_create_bulk_write_job',
  {
    "operation": "insert",
    "resource": [
      {
        "type": "data",
        "file_names": [
          "Example"
        ],
        "module": {
          "api_name": "Example"
        },
        "file_id": "file_123",
        "find_by": "id"
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_bulk_write_create_bulk_write_job --input '{
  "operation": "insert",
  "resource": [
    {
      "type": "data",
      "file_names": [
        "Example"
      ],
      "module": {
        "api_name": "Example"
      },
      "file_id": "file_123",
      "find_by": "id"
    }
  ]
}' --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": "success",
    "code": "SUCCESS",
    "message": "success",
    "details": {
      "id": "id_123",
      "created_by": {
        "id": "id_123"
      }
    }
  }
}
```

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

## Input reference

Bulk write job creation request

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.character_encoding` | `string` | No | — | Character encoding of the file Maximum length: 50. |
| `payload.operation` | `"insert" \| "update" \| "upsert"` | Yes | — | Type of bulk operation to perform Allowed: `insert`, `update`, `upsert`. |
| `payload.callback` | `object` | No | — | Callback configuration for job completion notification |
| `payload.resource` | `array` | Yes | — | List of resources to process in bulk Maximum items: 100. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Bulk write job creation request",
    "properties": {
      "character_encoding": {
        "type": [
          "string",
          "null"
        ],
        "description": "Character encoding of the file",
        "maxLength": 50
      },
      "operation": {
        "type": "string",
        "description": "Type of bulk operation to perform",
        "enum": [
          "insert",
          "update",
          "upsert"
        ]
      },
      "callback": {
        "type": "object",
        "description": "Callback configuration for job completion notification",
        "properties": {
          "url": {
            "type": "string",
            "description": "Callback URL to receive job completion notification",
            "format": "uri"
          },
          "method": {
            "type": "string",
            "description": "HTTP method for callback",
            "enum": [
              "post"
            ]
          }
        },
        "required": [
          "url",
          "method"
        ],
        "additionalProperties": false
      },
      "resource": {
        "type": "array",
        "description": "List of resources to process in bulk",
        "maxItems": 100,
        "items": {
          "type": "object",
          "description": "Resource configuration for bulk operation",
          "properties": {
            "type": {
              "type": "string",
              "description": "Type of resource",
              "enum": [
                "data"
              ]
            },
            "file_names": {
              "type": "array",
              "description": "List of file names to process",
              "maxItems": 10,
              "items": {
                "type": "string",
                "description": "File name",
                "maxLength": 255
              }
            },
            "module": {
              "type": "object",
              "description": "Target module for bulk operation",
              "properties": {
                "api_name": {
                  "type": "string",
                  "description": "API name of the module",
                  "maxLength": 100
                }
              },
              "required": [
                "api_name"
              ],
              "additionalProperties": false
            },
            "file_id": {
              "type": "string",
              "description": "ID of the uploaded file",
              "maxLength": 100
            },
            "ignore_empty": {
              "type": "boolean",
              "description": "Whether to ignore empty values"
            },
            "find_by": {
              "type": "string",
              "description": "Field to use for finding existing records",
              "enum": [
                "id"
              ]
            },
            "field_mappings": {
              "type": "array",
              "description": "Mapping between file columns and module fields",
              "maxItems": 500,
              "items": {
                "type": "object",
                "description": "Field mapping configuration",
                "properties": {
                  "api_name": {
                    "type": "string",
                    "description": "API name of the field",
                    "maxLength": 100
                  },
                  "index": {
                    "type": "integer",
                    "description": "Column index in the file",
                    "format": "int32"
                  }
                },
                "required": [
                  "api_name",
                  "index"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "type",
            "file_names",
            "module",
            "file_id",
            "find_by"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "operation",
      "resource"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Successful bulk write job creation response |
| `result.data.status` | `"success"` | Yes | — | Status of the operation Allowed: `success`. |
| `result.data.code` | `"SUCCESS" \| "FILE_UPLOAD_SUCCESS"` | Yes | — | Response code indicating the result Allowed: `SUCCESS`, `FILE_UPLOAD_SUCCESS`. |
| `result.data.message` | `"success" \| "file uploaded."` | Yes | — | Response message Allowed: `success`, `file uploaded.`. |
| `result.data.details` | `object` | Yes | — | Details of the created bulk write job |
| `result.data.details.id` | `string` | Yes | — | Unique identifier of the bulk write job Maximum length: 100. |
| `result.data.details.created_by` | `object` | Yes | — | User who created the bulk write job |
| `result.data.details.created_by.id` | `string` | Yes | — | User ID Maximum length: 100. |
| `result.data.details.created_by.name` | `string` | No | — | User name Maximum length: 100. |
| `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": "Successful bulk write job creation response",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the operation",
            "enum": [
              "success"
            ]
          },
          "code": {
            "type": "string",
            "description": "Response code indicating the result",
            "enum": [
              "SUCCESS",
              "FILE_UPLOAD_SUCCESS"
            ]
          },
          "message": {
            "type": "string",
            "description": "Response message",
            "enum": [
              "success",
              "file uploaded."
            ]
          },
          "details": {
            "type": "object",
            "description": "Details of the created bulk write job",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier of the bulk write job",
                "maxLength": 100
              },
              "created_by": {
                "type": "object",
                "description": "User who created the bulk write job",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "User ID",
                    "maxLength": 100
                  },
                  "name": {
                    "type": "string",
                    "description": "User name",
                    "maxLength": 100
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "id",
              "created_by"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "status",
          "code",
          "message",
          "details"
        ],
        "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.