Status of Transfer Records and Delete Users

Purpose

To get the status of the "transfer records and delete user" job scheduled previously.

Endpoints

GET /users/actions/transfer_and_delete?job_id={job_id}

Request Details

Request URL

{api-domain}/crm/{version}/users/actions/transfer_and_delete?job_id={job_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.users.READ
or
scope=ZohoCRM.users.ALL

Parameters

job_idinteger, mandatory
The ID of the job scheduled previously through the Transfer Records and Delete User API.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/users/actions/transfer_and_delete?job_id=3652397000012622009"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON Keys

statusstring
Indicates the status of the job. the possible values are "completed", "failed", "in_progress"

Possible Errors

REQUIRED_PARAM_MISSINGHTTP 400
You have not included job_id parameter in the request.
Resolution: Include the "job_id" you received in the response of the Transfer Records and Delete User API.

Sample Response

Copied{
    "transfer_and_delete": [
        {
            "status": "completed"
        }
    ]
}