Zoho: Transfer a user

← Users transfer operations · Get started

Operation zoho.usertransferapi

Provider route: POST /crm/v8/users/{userId}/actions/transfer. 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"]["userTransferApi"]>[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.userTransferApi(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_api(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	Represents the request body to transfer a user’s records, assignments, criteria, and subordinates to another user. Additional keys: not allowed
body.transfer	array	Required within parent	Specify the list of transfer operations to perform for the user. Only one transfer operation is allowed per request. Maximum items: 1
body.transfer[]	object	Each item	Each object specifies the details of the transfer operation including subordinate reassignment and data transfer preferences. Additional keys: not allowed
body.transfer[].move_subordinate	object	Required within parent	The details of the new user you want to transfer the subordinates of the old user to. Additional keys: not allowed
body.transfer[].move_subordinate.id	string	Required within parent	Specify the unique identifier of the user to whom the subordinates are reassigned. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values. Maximum length: 19
body.transfer[].transfer	object	Required within parent	The details of the new user you want to transfer the records of the old user to. Additional keys: not allowed
body.transfer[].transfer.assignment	boolean	Optional	Specify whether to transfer the record assignments to the target user.
body.transfer[].transfer.criteria	boolean	Optional	Specify whether to transfer the criteria-based data to the target user.
body.transfer[].transfer.id	string	Required within parent	Specify the unique identifier of the user to whom the data is transferred. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values. Maximum length: 19
body.transfer[].transfer.records	boolean	Optional	Specify whether to transfer the records to the target 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 operation Additional keys: not allowed
transfer	array	Required within parent	Represents an array containing transfer operation results. Maximum items: 1
transfer[]	object	Each item	Each object represents the result of the user transfer operation. Additional keys: not allowed
transfer[].code	string	Required within parent	Represents the response code indicating operation scheduled. Known values: SCHEDULED
transfer[].details	object	Required within parent	Represents the additional details about the scheduled operation. Additional keys: not allowed
transfer[].details.job_id	string	Required within parent	Represents the unique identifier of the scheduled job created for the transfer operation. Maximum length: 19
transfer[].message	string	Required within parent	Represents the message describing the result. Maximum length: 500
transfer[].status	string	Required within parent	Represents the status of the transfer operation. Maximum length: 100

Policy, approvals and errors

SDK function policy ID: zoho.usertransferapi. Catalog operation: userTransferAPI. 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