younifyd
Menu

Create a bulk write job

Create a bulk write job

POST/write

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Create a bulk write job action (under Bulk Write).
  3. Fill in the fields below, then reference the result from later steps as {{createABulkWriteJob.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

character_encodingstring | null

Specify the character encoding of the uploaded file. Zoho CRM auto-detects the encoding when this value is omitted; supply a value to override auto-detection and force the file to be read with the specified charset.

operationstringrequired

Specify the type of bulk write operation to perform on the file. Possible values: insert - Creates the records from the file as new records in the target module. update - Updates existing records in the target module without creating new ones. upsert - Updates existing records and creates new records that do not exist already.

One ofinsertupdateupsert

callbackobject

Specify the callback configuration that Zoho CRM uses to notify your endpoint when the bulk write job completes or fails.

urlstring (uri)required

Specify the URL that receives the job completion notification. The URL must accept the HTTP POST method and be reachable from Zoho CRM servers.

methodstringrequired

Specify the HTTP method that Zoho CRM uses to invoke the callback URL. Possible values: post - Sends the job completion notification as an HTTP POST request.

One ofpost

resourcearray<object>required

Specify the list of resource configurations to process in the bulk write job. Each entry describes the target module, the uploaded file to read, and the field mappings to apply.

typestringrequired

Specify the type of the resource being imported. Possible values: data - Indicates that the resource contains record data to be written into the target module.

One ofdata

file_namesarray<string>required

Specify the names of the files inside the uploaded archive that the bulk write job must process.

moduleobjectrequired1 fields

Specify the target CRM module into which the records from the uploaded file are written.

file_idstringrequired

Specify the identifier of the previously uploaded file that the bulk write job must read. Obtain this value from the response of the bulk upload file API.

ignore_emptyboolean

Specify whether to skip empty cells in the uploaded file when updating records. Possible values: true - Ignores empty values in a column and updates only the fields that carry a non-empty value. false - Updates the target field with the empty value supplied in the file.

find_bystringrequired

Specify the field that the bulk write job uses to locate existing records when performing an update or upsert operation. Possible values: id - Matches records by their unique record ID in the target module.

One ofid

field_mappingsarray<object>2 fields

Specify the mapping between columns in the uploaded file and fields on the target module. When omitted, Zoho CRM auto-maps columns to fields whose API names match the CSV header.

json
{
  "operation": "insert",
  "resource": [
    {
      "type": "data",
      "file_names": [
        "string"
      ],
      "module": {
        "api_name": "string"
      },
      "file_id": "string",
      "find_by": "id",
      "ignore_empty": false,
      "field_mappings": [
        {
          "api_name": "string",
          "index": 0
        }
      ]
    }
  ],
  "character_encoding": "string",
  "callback": {
    "url": "string",
    "method": "post"
  }
}

Response

Returns 201 with an object. Read it in later steps with {{createABulkWriteJob.response.data.<field>}}.

statusstring

Represents the overall status of the bulk write job creation request. Possible values: success - Indicates that Zoho CRM scheduled the bulk write job successfully.

One ofsuccess

codestring

Represents the response code returned for the bulk write job creation. Possible values: **SUCCESS** - Indicates that the bulk write job was scheduled successfully. **FILE_UPLOAD_SUCCESS** - Indicates that the file associated with the job was uploaded successfully.

One ofSUCCESSFILE_UPLOAD_SUCCESS

messagestring

Represents the response message for the bulk write job creation. Possible values: **success** - Confirms that Zoho CRM scheduled the bulk write job. **file uploaded** - Confirms that Zoho CRM accepted the uploaded file for the job.

One ofsuccessfile uploaded.

detailsobject

Represents the details of the newly scheduled bulk write job.

idstringrequired

Represents the unique identifier of the newly scheduled bulk write job. Use this value to query the job status through the get job details operation.

created_byobjectrequired2 fields

Represents the Zoho CRM user who created the bulk write job.

json
{
  "status": "success",
  "code": "SUCCESS",
  "message": "success",
  "details": {
    "id": "string",
    "created_by": {
      "id": "string",
      "name": "string"
    }
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.