Get mass update job status

GET/{module}/actions/mass_update

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get mass update job status action (under Records).
Fill in the fields below, then reference the result from later steps as {{getMassUpdateJobStatus.response.data}}.

Request

Path parameters

modulestringrequired

Specify the API name of the CRM module on which the mass update operation must be performed. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to fetch the valid API name of the module.

One ofLeadsAccountsContactsDealsCampaignsTasksCallsMeetingsCasesSolutionsProductsVendorsPrice_BooksQuotesSales_OrdersPurchase_OrdersInvoicesCustom

Query parameters

job_idstring (int64)required

Specify the unique ID of the mass update job whose status must be retrieved. This is the `job_id` returned in the response of the [Mass Update API](mass_update.yaml#$/{module}/actions/mass_update.post) request.

Response

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

dataarray<object>

Represents the array that contains the status object for the requested mass update job.

Statusstringrequired

Represents the current state of the mass update job. Possible values: COMPLETED - The mass update job has finished processing all records. SCHEDULED - The mass update job has been queued and is waiting to start. QUEUED - The mass update job is queued in the system. RUNNING - The mass update job is currently processing records. SUSPENDED - The mass update job has been paused. FAILED - The mass update job has terminated due to a failure.

One ofCOMPLETEDSCHEDULEDQUEUEDRUNNINGSUSPENDEDFAILED

Failed_Countinteger (int32)required

Represents the number of records that failed to update due to validation errors or other processing failures during the mass update job.

Updated_Countinteger (int32)required

Represents the number of records that were successfully updated by the mass update job.

Not_Updated_Countinteger (int32)required

Represents the number of records that are not yet updated by the mass update job.

Total_Countinteger (int32)required

Represents the total number of records that were scheduled to be mass updated by the job.

json

{
  "data": [
    {
      "Status": "COMPLETED",
      "Failed_Count": 0,
      "Updated_Count": 0,
      "Not_Updated_Count": 0,
      "Total_Count": 0
    }
  ]
}

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

Was this page helpful?