Mass Change Owner Status

Purpose

To get the status of the mass change owner job scheduled previously.

Endpoints

Request Details

Request URL

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

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Meetings, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.change_owner.READ

Parameters

  • job_idstring, mandatory

    Specifies the unique ID of the mass change owner job scheduled previously using Mass Change Owner API.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v4/Leads/actions/mass_change_owner?job_id=3652397000009565021"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

  • Total_Countinteger

    Specifies the total number of records whose owners you wanted to change.

  • Updated_Countinteger

    Specifies the number of records whose owners were successfully changed.

  • Not_Updated_Countinteger

    Specifies the number of records whose owners are not changed, yet.

  • Failed_Countinteger

    Specifies the number of records whose owners were not changed.

  • Statusstring

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

Possible Errors

  • REQUIRED_PARAM_MISSINGHTTP 404

    You have not specified the job_id in the request.
    Resolution: The specified job_id is not found or invalid. Specify a valid job_id

  • 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: You do not have ZohoCRM.change_owner.CREATE scope. Create new tokens with valid scope. Refer to the scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read records
    Resolution: The user does not have permission to retrieve mass change owner.

Sample Response

Copied{
    "data": [
        {
            "Total_Count": 50000,
            "Updated_Count": 49500,
            "Not_Updated_Count": 0,
            "Failed_Count": 500,
            "Status": "COMPLETED"
        }
    ]
}