Get Records Merge Status

Purpose

To get the status of previously scheduled records merge job.

Endpoints

  • GET /{module_api_name}/{master_record_ID}/actions/merge

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{master_record_ID}/actions/merge

Supported Modules

Leads, Contacts, Accounts, Deals, Vendors and Custom.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible Module Names

leads, contacts, deals, accounts, vendors and custom.

Possible Operation Types

READ - Get records in a module.
ALL - Full access to the record.

Parameter

  • job_idstring, optional

    The ID represents the unique identifier of your scheduled merge job, which you get from the response of the Merge Records API.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/2378988000000509963/actions/merge"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

  • job_idstring

    Specifies the unique ID of the scheduled merge job.

  • statusstring

    Specifies the current status of the scheduled call. 
    Possible values: RUNNING, SCHEDULED, COMPLETED, and FAILURE.

Sample Response

Copied{
    "merge": [
        {
            "job_id": "2423488000000513988",
            "status": "COMPLETED"
        }
    ]
}

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The request method is incorrect
    Resolution: Use the HTTP GET method to make this API call. Any other request method will result in this error.

  • INVALID_DATAHTTP 400

    Specified master record ID is invalid
    Resolution: Please specify the valid master record ID.

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name. Specify a valid module name.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    The access token you have used to make this API call does not have the required scope.
    Resolution: Client does not have ZohoCRM.module.{module_api_name}.READ scope. Create a new token with required scopes. 

  • AUTHENTICATION_FAILUREHTTP 401

    You have not authorized the API call with valid access token.
    Resolution:  Include a valid access token in the request header to authorize the API call.

  • INVALID_URL_PATTERNHTTP 404

    The request URL is incorrect.
    Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details. Refer to the request URL section above.

  • INTERNAL_ERRORHTTP 500

    Unexpected and unhandled exception in the server. 
    Resolution: Contact the support team at support@zohocrm.com.