Zoho: Transfer and delete a user — users Transfer user Transfer

← Users transfer operations · Get started

Operation zoho.usertransfer

Provider route: POST /crm/v8/users/{userId}/actions/transfer_and_delete. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["usersTransfer"]["userTransfer"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.usersTransfer.userTransfer(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.users_transfer.user_transfer(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.userId	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
body	object	Required within parent	Request body for transferring and deleting user data Additional keys: not allowed
body.transfer_and_delete	array	Required within parent	Specify the list of transfer and delete operations. The array accepts a maximum of one object. Maximum items: 1
body.transfer_and_delete[]	object	Each item	Each object specifies the details for the transfer and delete operation. Additional keys: not allowed
body.transfer_and_delete[].move_subordinate	object	Required within parent	Specify the details of the user to whom the subordinates of the deleted user are moved. Additional keys: not allowed
body.transfer_and_delete[].move_subordinate.id	string	Required within parent	Specify the unique identifier of the user to whom the subordinates are moved. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values. Maximum length: 19
body.transfer_and_delete[].transfer	object	Required within parent	Specify the transfer settings for records, assignments, and criteria of the deleted user. Additional keys: not allowed
body.transfer_and_delete[].transfer.assignment	boolean	Optional	Specify whether to replace the user in assignment rules, escalation rules, field updates, and automation actions.
body.transfer_and_delete[].transfer.criteria	boolean	Optional	Specify whether to replace the user in criteria for custom views, automation, and reports.
body.transfer_and_delete[].transfer.id	string	Required within parent	Specify the unique identifier of the user to whom the records are transferred. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values. Maximum length: 19
body.transfer_and_delete[].transfer.records	boolean	Optional	Specify whether to transfer the open records of the deleted user to the new user.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Provides the response body for successful user transfer and delete operation. Additional keys: not allowed
transfer_and_delete	array	Required within parent	Represents the list of transfer and delete operation results. The array contains a maximum of one object. Maximum items: 1
transfer_and_delete[]	object	Each item	Represents the result of a single transfer and delete operation. Additional keys: not allowed
transfer_and_delete[].code	string	Required within parent	Represents the response code of the operation. Known values: SUCCESS
transfer_and_delete[].details	object	Required within parent	Represents additional details about the scheduled transfer and delete operation, including the job ID. Additional keys: not allowed
transfer_and_delete[].details.job_id	string	Required within parent	Represents the unique identifier of the scheduled transfer and delete job. Use this ID with the [status](users_transfer.yaml#$.paths./users/actions/transfer_and_delete.get) endpoint to track the progress of the job. Maximum length: 50
transfer_and_delete[].message	string	Required within parent	Represents the message describing the result of the operation. Maximum length: 500
transfer_and_delete[].status	string	Required within parent	Represents the status of the operation. Maximum length: 100

Policy, approvals and errors

SDK function policy ID: zoho.usertransfer. Catalog operation: userTransfer. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source