younifyd
Menu

Get bulk write job details

Get bulk write job details

GET/write/{jobId}

Use it in a workflow

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

Request

Path parameters

jobIdstringrequired

Specify the unique identifier of the bulk write job whose details you want to retrieve.

Response

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

statusstring

Represents the current overall status of the bulk write job. Sample values include **ADDED**, **INPROGRESS**, **COMPLETED**, and **SKIPPED**.

character_encodingstring

Represents the character encoding used to read the uploaded file. Returned with the value detected automatically by Zoho CRM, or with the value supplied in the original create request when it was specified.

resourcearray<object>

Represents the list of resource entries processed by the bulk write job, one entry per resource configuration submitted in the create request.

statusstringrequired

Represents the processing status of this resource entry. Possible values: **COMPLETED** - All records in the resource were processed successfully. **ADDED** - The resource was queued for processing. **INPROGRESS** - The resource is currently being processed. **SKIPPED** - The resource was skipped without being processed.

One ofCOMPLETEDADDEDINPROGRESSSKIPPED

typestringrequired

Represents the type of the processed resource. Possible values: **data** - Indicates that the resource contained record data.

One ofdata

moduleobjectrequired2 fields

Represents the target CRM module into which the resource was written.

ignore_emptyboolean

Indicates whether empty cells in the uploaded file were skipped when updating records. Possible values: **true** - Empty values in a column were ignored and only non-empty values were written. **false** - Empty values in a column were written to the corresponding field.

field_mappingsarray<object>7 fields

Represents the field mappings applied between columns in the uploaded file and fields on the target module for this resource.

fileobject6 fields

Represents the per-file processing summary for this resource entry.

codestring

Represents the result code returned by Zoho CRM for the processing of this resource entry.

idstring

Represents the unique identifier of the bulk write job.

resultobject

Represents the result metadata of the completed bulk write job, including the **download URL** of the result archive.

download_urlstringrequired

Represents the URL from which the result archive of the bulk write job can be downloaded. The download URL is accessible for up to **seven** days after job completion.

created_byobject

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

namestringrequired

Represents the display name of the Zoho CRM user who created the bulk write job. Refer to the [Users API](users.yaml#$.paths./users.get) endpoint for details.

idstringrequired

Represents the unique identifier of the Zoho CRM user who created the bulk write job. Refer to the [Users API](users.yaml#$.paths./users.get) endpoint for details.

operationstring

Represents the type of bulk write operation performed by the job, such as **insert**, **update**, or **upsert**.

created_timestring (date-time)

Represents the ISO 8601 timestamp at which Zoho CRM created the bulk write job.

callbackobject

Represents the callback configuration registered for the bulk write job, used to notify the configured URL when the job completes or fails.

urlstringrequired

Represents the URL that receives the job completion notification. Possible values: http://requestbin.fullcontact.com/1fcimk51 - Sample callback URL recorded for the job.

One ofhttp://requestbin.fullcontact.com/1fcimk51

methodstringrequired

Represents the HTTP method used to invoke the callback URL. Possible values: post - The callback URL is invoked with an HTTP POST request.

One ofpost

json
{
  "status": "string",
  "resource": [
    {
      "status": "COMPLETED",
      "type": "data",
      "module": {
        "api_name": "string",
        "id": "string"
      },
      "ignore_empty": false,
      "field_mappings": [
        {
          "api_name": "string",
          "index": 0,
          "format": "string",
          "find_by": "string",
          "default_value": {
            "value": "string"
          },
          "parent_column_index": 0,
          "module": "string"
        }
      ],
      "file": {
        "status": "COMPLETED",
        "name": "string",
        "added_count": 0,
        "skipped_count": 0,
        "updated_count": 0,
        "total_count": 0
      },
      "code": "string"
    }
  ],
  "id": "string",
  "created_by": {
    "name": "string",
    "id": "string"
  },
  "operation": "string",
  "created_time": "2025-01-01T00:00:00Z",
  "callback": {
    "url": "http://requestbin.fullcontact.com/1fcimk51",
    "method": "post"
  },
  "character_encoding": "string",
  "result": {
    "download_url": "string"
  }
}

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