Get Mass Update Status

Purpose

To get the status of the mass update job scheduled previously.

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/actions/mass_update?job_id={job_id}

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Activities, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.mass_update.{module_name}.READ

Possible module names

leads, accounts, contacts, deals, campaigns, activities, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom

Request JSON Keys

  • job_idstring, mandatory

    Specifies the unique ID of the mass update job obtained in the response of Mass Update Records.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2.1/Accounts/actions/mass_update?job_id=554023000000506003"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
4.0.0
Copied//Get instance of RecordOperations Class
$recordOperations = new RecordOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(GetMassUpdateStatusParam::jobId(), $jobId);
//Call getRecord method that takes paramInstance, moduleAPIName as parameter
$response = $recordOperations->getMassUpdateStatus($moduleAPIName,$paramInstance);
Copied<?php
class GetMassUpdateStatus{
    
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2.1/Leads/actions/mass_update?";
        $parameters = array();
        $parameters["job_id"]="3524033000006027001";

        
        foreach ($parameters as $key=>$value){
            $url =$url.$key."=".$value."&";
        }
        $curl_options[CURLOPT_URL] = $url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
        $headersArray = array();
        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);
        
        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
        
    }
    
}
(new GetMassUpdateStatus())->execute();
2.1.0
Copied# Get instance of ParameterMap Class
pm = ParameterMap.new
# Possible parameters for Get MassUpdate Status operation
pm.add(Record::RecordOperations::GetMassUpdateStatusParam.job_id, job_id)
# Get instance of RecordOperations Class
rr = Record::RecordOperations.new
# Call getMassUpdateStatus method that takes ParameterMap instance and module_api_name as parameter
response = rr.get_mass_update_status(module_api_name,pm)
Copiedrequire 'net/http'
require 'json'

class GetMassUpdateStatus 

    def execute
        parameters ={}
        parameters["job_id"]="3524033000006027001"
        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
        url= "https://www.zohoapis.com/crm/v2.1/Leads/actions/mass_update"
        url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
        url = URI(url)
        req = Net::HTTP::Get.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
        headers&.each { |key, value| req.add_field(key, value) }
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end
GetMassUpdateStatus.new.execute
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/Accounts/actions/mass_update?job_id= 554023000000506003s"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON Keys

  • Statusstring

    Indicates the status of mass update. Possible values are "COMPLETED", "SCHEDULED", "RUNNING", and "FAILED".

  • Failed_Countinteger

    Specifies the number of records that failed to be mass updated.

  • Updated_Countinteger

    Specifies the number of records that were successfully mass updated.

  • Not_Updated_Countinteger

    Specifies the number of records that are not updated yet.

  • Total_Countinteger

    Specifies the total number of records that were scheduled to be mass updated

Possible Errors

  • NOT_FOUNDHTTP 404

    Empty response
    Resolution: The specified job_id is not found or invalid. Specify a valid job_id

  • MANDATORY_NOT_FOUNDHTTP 400

    mandatory param missing
    Resolution: The parameter "job_id" is not included in the request

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.mass_update.{module_name}.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read records
    Resolution: The user does not have permission to retrieve mass update status. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to read records
    Resolution: The user does not have the permission to retrieve mass update status. Contact your system administrator.

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

Sample Response For Job Complete

CopiedFor Job Completed
{
    "data": [
        {
            "Status": "COMPLETED",
            "Failed_Count": 0,
            "Updated_Count": 50,
            "Not_Updated_Count": 0,
            "Total_Count": 50
        }
    ]
}

For Job Failed
{
    "data": [
        {
            "Status": "FAILED",
            "Failed_Count": 50,
            "Updated_Count": 0,
            "Not_Updated_Count": 0,
            "Total_Count": 50
        }
    ]
}

For Job Scheduled
{
    "data": [
        {
            "Status": "SCHEDULED",
            "Failed_Count": 0,
            "Updated_Count": 0,
            "Not_Updated_Count": 50,
            "Total_Count": 50
        }
    ]
}

For Job In Progress
{
    "data": [
        {
            "Status": "RUNNING",
            "Failed_Count": 0,
            "Updated_Count": 30,
            "Not_Updated_Count": 20,
            "Total_Count": 50
        }
    ]
}