Zoho: Transfer and delete a specific territory by ID

← Territories operations · Get started

Operation zoho.transferanddeleteterritorybyid

Provider route: POST /crm/v8/settings/territories/{id}/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["territories"]["transferAndDeleteTerritoryById"]>[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.territories.transferAndDeleteTerritoryById(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.territories.transfer_and_delete_territory_by_id(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.id	string	Required within parent	Represents the list of Territory Id. Provide the ID of the territory. Use the [Ger Territories API](territories.yaml#$.paths./settings/territories.get) to get the valid values. Format: int64
body	object	Required within parent	Specify the transfer configuration for the territory to delete. Additional keys: not allowed
body.territories	array	Required within parent	Specify the transfer details for the territory to delete. Maximum items: 1 Minimum items: 1
body.territories[]	object	Each item	Specify the transfer configuration for the territory to delete, including the target territory for child territory reassignment and the forecast deletion preference. Additional keys: not allowed
body.territories[].delete_previous_forecasts	boolean	Optional	Specify whether to delete previous forecasts associated with the territory. Possible values: true - Deletes the previous forecasts for the territory. false - Retains the previous forecasts for the territory.
body.territories[].id	string	Optional	Specify the unique ID of the territory to delete. If omitted, the operation uses the territory ID from the URL path parameter. Format: int64
body.territories[].transfer_to_id	string	Required within parent	Specify the unique ID of the parent territory to which child territories are transferred before deleting the specified territory. The target territory must be higher in the hierarchy than the territory to delete. Format: int64

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
$	Model	Root	Expand Transfer and delete territories — response body

Referenced models: Transfer and delete territories — response body

Schemas

Transfer and delete territories — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when a territory is successfully transferred and deleted. Additional keys: not allowed
territories	array	Required within parent	Represents the list of territory objects transferred and deleted by the request. Maximum items: 100 Minimum items: 1
territories[]	object	Each item	Represents the error details for a single territory transfer and delete operation. Additional keys: not allowed
territories[].code	string	Required within parent	Represents the result code for the territory transfer and deletion. Possible values: **SUCCESS**. Known values: SUCCESS
territories[].details	object	Required within parent	Represents additional details about the transferred and deleted territory, including its unique identifier. Additional keys: not allowed
territories[].details.id	string	Required within parent	Represents the unique identifier of the transferred and deleted territory. Format: int64
territories[].message	string	Required within parent	Represents the success message returned for the territory transfer and deletion. Possible values: **Territory Transferred And Deleted Successfully**, **Given Territory Removed Successfully and its child Territories moved to the another territory**. Known values: Territory Transferred And Deleted Successfully, Given Territory Removed Successfully and its child Territories moved to the another territory Maximum length: 100
territories[].status	string	Required within parent	Represents the status of the territory transfer and delete operation. Possible values: **success**. Known values: success

Policy, approvals and errors

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