Get Records Merge Status

Purpose

To get the status of previously scheduled records merge job.

Endpoints

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/v6/Leads/2378988000000509963/actions/merge"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

  • 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 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 the endpoints section above.

  • 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

    Unauthorized
    Resolution: Client does not have ZohoCRM.module.{module_api_name}.READ scope.
    Create a new token with required scopes. Refer to scope section above.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed
    Resolution: Pass the access token in the request header of the API call.

  • 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 the request URL section above.

  • INTERNAL_ERRORHTTP 500

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